Add basic documentation + small fixes #4
Merged
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
aperloff
reviewed
Jun 17, 2024
|
|
||
| Then open `_build/html/index.html` to browse the docs locally. | ||
|
|
||
| Note that if you updated docstrings, you'll need to re-build and re-install ssapy before re-building the docs. |
There was a problem hiding this comment.
You might add that you can also use the python package sphinx-autobuild to build and host the documentation (https://pypi.org/project/sphinx-autobuild/). To view the documentation point the browser to http://127.0.0.1:8000/.
There was a problem hiding this comment.
Nice! I tried but I'm using python 3.9 and the version of sphinx-autobuild I have installed requires python 3.10+ (we should pin versions!)
I still added it to the README!
| @@ -34,7 +34,7 @@ These requirements can be easily installed on most modern macOS and Linux system | |||
| .. code-block:: console | |||
|
|
|||
| brew update | |||
| brew install gcc git git-lfs python3 svn graphviz | |||
| brew install gcc git git-lfs python3 graphviz | |||
There was a problem hiding this comment.
It couldn't tell why it was needed, I didn't install it and didn't run into any issues, and it didn't seem required for other platforms (lines above) so I assumed it was outdated. Is it still needed?
aperloff
pushed a commit
that referenced
this pull request
Jan 13, 2025
Add basic documentation + small fixes
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.
Add some basic documentation for the API reference. Also clean up some of the imports so that the imported classes don't appear as duplicates in the API reference. I wonder if there is a cleaner way to do that than importing
Thing as _Thinglike I did.Add a README in
docs/to explain how to build the docs.Also fix some leftover
x2y->x_to_yreferences to util functions, mostly in tests.