Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix Sphinx build #880

Merged
merged 2 commits into from
Oct 24, 2024
Merged

docs: fix Sphinx build #880

merged 2 commits into from
Oct 24, 2024

Conversation

kentbull
Copy link
Contributor

@kentbull kentbull commented Oct 15, 2024

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
Copy link
Contributor Author

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.

Copy link
Member

@m00sey m00sey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems to be missing the vdr package

@m00sey
Copy link
Member

m00sey commented Oct 15, 2024

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
Copy link
Contributor Author

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

image

@kentbull
Copy link
Contributor Author

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
Copy link
Member

m00sey commented Oct 16, 2024

LGTM - however I dislike the theme lol

docs/conf.py Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@kentbull kentbull mentioned this pull request Oct 16, 2024
@m00sey m00sey merged commit 4728272 into WebOfTrust:main Oct 24, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants