Sphinx Documentation #121
Open
Sphinx Documentation #121
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
thisisjube
force-pushed
the
sphinx_docs
branch
from
e584780 to
d778222
Compare
thisisjube
force-pushed
the
sphinx_docs
branch
from
824f5cb to
0bcecbd
Compare
thisisjube
force-pushed
the
sphinx_docs
branch
from
f58316d to
aba265d
Compare
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.
This PR is intended to enhance the documentation of SLOTHY. It has been created using sphinx. Sphinx allows adding custom markdown/ rst files (as for the SLOTHY Tutorial) and auto-generates an API reference from the existing doc strings. Effectively, Sphinx creates a bunch of HTML files that could be hosted via GitHub pages. A well-organized and visually appealing documentation could help remove obstacles for users and developers working with SLOTHY.
Try it yourself: After installing the python dependencies via the
requirements.txtfile you can start the build process withcd docs make htmland open the
docs/build/index.htmlfile with your browser.