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 refresh #112

Merged
merged 7 commits into from
Aug 19, 2024
Merged

Docs refresh #112

merged 7 commits into from
Aug 19, 2024

Conversation

ZedThree
Copy link
Collaborator

  • Better method for autogenerating the API docs using a recursive template
  • Switch to sphinx-book-theme because I think it looks better and is easier to navigate
  • Fix a bunch of sphinx warnings

There's still a few warnings left, but I've fixed the low hanging fruit at least

bendudson
bendudson previously approved these changes Jun 28, 2024
@ZedThree
Copy link
Collaborator Author

ZedThree commented Jul 2, 2024

The remaining warnings are now all due to a bug in Sphinx. Basically it doesn't generate links to inherited methods from the derived class, which is a little annoying.

Copy link
Collaborator

@bendudson bendudson left a comment

Choose a reason for hiding this comment

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

Thanks @ZedThree !

@bendudson bendudson merged commit c1b4f14 into master Aug 19, 2024
9 checks passed
@bendudson bendudson deleted the docs-refresh branch August 19, 2024 15:35
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