We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs
I generated the docs directory using the sphinx-quickstart command ./docs
sphinx-quickstart
./docs
index.rst
this page includes the README file using m2r2, and then includes a hidden table of contents (so the sidebar includes these links)
m2r2
nemspy/docs/source/index.rst
Lines 1 to 9 in 08b454c
Sphinx can use automodule, autoclass, and autofunction
automodule
autoclass
autofunction
nemspy/docs/source/nemspy.interface.rst
Lines 1 to 4 in 08b454c
nemspy/setup.py
Line 42 in 08b454c
pip install -e .[documentation]
to build the website with Sphinx, run the following:
cd docs make html
nemspy/.readthedocs.yml
Lines 1 to 20 in 08b454c
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Sphinx RST files in
docs
directoryI generated the
docs
directory using thesphinx-quickstart
command./docs
index.rst
(docs homepage)this page includes the README file using
m2r2
, and then includes a hidden table of contents (so the sidebar includes these links)nemspy/docs/source/index.rst
Lines 1 to 9 in 08b454c
example of a module page
Sphinx can use
automodule
,autoclass
, andautofunction
nemspy/docs/source/nemspy.interface.rst
Lines 1 to 4 in 08b454c
dependencies
nemspy/setup.py
Line 42 in 08b454c
building locally
to build the website with Sphinx, run the following:
cd docs make html
ReadTheDocs configuration
nemspy/.readthedocs.yml
Lines 1 to 20 in 08b454c
The text was updated successfully, but these errors were encountered: