Sphinx and Autodoc generation #50
Open
Conversation
This file contains hidden or 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
jayceslesar
reviewed
May 18, 2024
Comment on lines
+100
to
105
| """ | ||
| Accumulate a trace of statistics for determining the likelihood of observed data under Markov transition | ||
| frequencies present in valid data. | ||
| Attributes: | ||
| length: The cumulative length of all inputs thus far. |
There was a problem hiding this comment.
does sphinx not work with google-notypes docstring convention? Or just favoring this style?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 sphinx auto-doc generator to allow us to easily make html/web pages using the python pydoc comments
Supports both google style and reStructuredText style
Adds the various related sphinx python requirements to the dev dependencies of
pdm.Run with
pdm run sphinx-build docs/source docs/buildYou can view by running a python http server from the
docs/buildfolder. I.e.cd docs/build/ && python -m http.server