search

WebOfTrust / keripy

Key Event Receipt Infrastructure - the spec and implementation of the KERI protocol
https://keripy.readthedocs.io/en/latest/
Apache License 2.0
60 stars 55 forks source link

docs: fix Sphinx build #880

Closed kentbull closed 1 month ago

kentbull commented 1 month ago

Upgrade Sphinx to 8.1.3 and myst-parser to 4.1.3.

  1. doing make clean html builds the docs.
  2. Open the docs on OSx with open _build/html/index.html

  3. Profit

    There are a bunch of warnings yet they don't stop the docs from building.

kentbull commented 1 month ago

took about 15 mins of work. What else, if anything, is missing from this? the docs build into the static assets _build dir and can be published. It seems complete to me.

m00sey commented 1 month ago

Appreciate it only took 15 minutes.

The local rendering for me does not have any detail, screenshot attached.

I assume this is just a templating issue, but it is what I referred to on the call.

Screenshot 2024-10-15 at 4 31 07 PM
kentbull commented 1 month ago

That's weird, I'm seeing all of the docs on my machine:

image

kentbull commented 1 month ago

I'm also seeing the VDR API:

image

And the details of the VDR API:

image

This is when I do an open ./_build/html/index.html from the OSx command line after a make clean html

m00sey commented 1 month ago

LGTM - however I dislike the theme lol