Documentation update: add readthedocs with sphinx #84
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
belsten
force-pushed
the
documentation
branch
from
689a9f2 to
a33b1e0
Compare
9q9q
requested changes
Feb 1, 2025
There was a problem hiding this comment.
Thanks so much Alex, this is awesome!! Just some minor comments, mostly just to make sure all the documentation is up to date with the recent restructuring PRs and slight changes to installation setup etc.
I think we can continue to edit the wording in the documentation as we go but no need for any major changes in this PR.
ivanov
approved these changes
Feb 7, 2025
…enerated docs, inference and models doesnt show up. Need to investigate this issue further
…still needs to be completed
…restructure proposed in recent issue.
… contributing.md as updated material is now in the readthedocs
…cs finds it and generates it
…exlude test files from autodocs
…opposed to in the __init__)
…Improve details of submitting PRs. Add information for reveiwers on how to merge pull requests.
belsten
force-pushed
the
documentation
branch
from
b2f6088 to
454c7e8
Compare
ivanov
pushed a commit
that referenced
this pull request
Feb 7, 2025
Recently merged documentation PR #84 contained incorrect installation command causing readthedocs to fail.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've added sphinx support with autodoc and autosummary with utilizes inline code blocks to generate documentation. In addition to this, I've added three additional pages with provide background info:
docs/install.rst: goes though installation proceduredocs/quickstart.rst: provides high-level info regarding repo structure, and pointer to notebooksdocs/contributing.rst: info regarding how to contribute (largely fromdocs/contributing.md- which is now deleted - and includes some updates)Updated the readme to provide pointers to these new resources and added some additional information about the repo.
I also updated the
__init__.pysuch that they import library functionalities, such that tab autocomplete works in IPython.