This repository has been archived by the owner on Aug 18, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
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
farice
suggested changes
Apr 28, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing that would be great is to get the tex to render in the docs via mathjax
Not sure if this helps: https://www.sphinx-doc.org/en/master/usage/extensions/math.html
Sorry just saw the last line of the desc - do we want to add this extension integration now or defer to another PR? |
Not sure what it will take to enable, so I'm thinking getting a first draft of docs up first would be good. |
farice
approved these changes
Apr 28, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Resolves #27
Adds infrastructure for using Sphinx to generate documentation from code. Initial
index.rst
andreference.rst
added to generate the docs..readthedocs.yaml
tweaks the default Read the Docs build to read from our Poetry compatiblepyproject.toml
This build can be viewed at https://qhbm-library--240.org.readthedocs.build/en/240/. Currently LaTeX in docstrings does not render, see #242