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
Describe the bug https://userguide.mdanalysis.org/stable/contributing_code.html#working-with-the-code-documentation links to https://userguide.mdanalysis.org/stable/contributing_code.html#id1 for setting up an environment that allows for building of docs.
However, not all necessary packages are include.
When then trying to build docs
python setup.py build_sphinx -E
one gets various errors from sphinx, corresponding to missing packages.
(On a sidenote, IIRC, python setup.py build_sphinx is deprecated and one is encouraged to use the make html in the doc directory.)
python setup.py build_sphinx
make html
Expected behavior I can copy and paste the build instructions and it works.
Actual behavior Error messages from sphinx about missing packages.
Additional context
The following are missing (pyproject.toml):
They can be installed with conda install pybtex pybtex-docutils sphinxcontrib-bibtex
Note that
can now also be conda-installed (no need for pip anymore).
The with conda installation instructions should then be
# documentation dependencies conda install sphinx pybtex pybtex-docutils sphinxcontrib-bibtex sphinx_rtd_theme sphinx-sitemap python -m pip install msmb_theme==1.2.0
(and remove sphinx from the conda installation command line that comes before the docs)
sphinx
The text was updated successfully, but these errors were encountered:
updated dependencies needed for sphinx docs
de30c46
- fix #260 - updated required dependencies for sphinx docs (especially the bibtex packages) - moved some packages from pip to conda
Successfully merging a pull request may close this issue.
Describe the bug
https://userguide.mdanalysis.org/stable/contributing_code.html#working-with-the-code-documentation links to https://userguide.mdanalysis.org/stable/contributing_code.html#id1 for setting up an environment that allows for building of docs.
However, not all necessary packages are include.
When then trying to build docs
one gets various errors from sphinx, corresponding to missing packages.
(On a sidenote, IIRC,
python setup.py build_sphinx
is deprecated and one is encouraged to use themake html
in the doc directory.)Expected behavior
I can copy and paste the build instructions and it works.
Actual behavior
Error messages from sphinx about missing packages.
Additional context
The following are missing (pyproject.toml):
They can be installed with
conda install pybtex pybtex-docutils sphinxcontrib-bibtex
Note that
can now also be conda-installed (no need for pip anymore).
The with conda installation instructions should then be
(and remove
sphinx
from the conda installation command line that comes before the docs)The text was updated successfully, but these errors were encountered: