Skip to content

Commit

Permalink
Moving requirements-docs.txt to pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
john-science committed Sep 18, 2023
1 parent 6bd90e7 commit eb0e12b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 48 deletions.
46 changes: 0 additions & 46 deletions doc/requirements-docs.txt

This file was deleted.

26 changes: 26 additions & 0 deletions pyproject.toml
Expand Up @@ -90,6 +90,32 @@ test = [
"pytest-xdist",
"ruff==0.0.272",
]
docs = [
#######################################################################
# These are most specified that usual, because Sphinx docs seem to be
# quite fragile limited <7 by sphinx-rtd-theme at the moment.
#
# sphinx-rtd-theme requires docutils <0.19 but sphinx dropped support
# for 0.18 in 6.0.0 so we're stuck at these versions.
#
# We are only building our docs with Python 3.9.
#######################################################################
"Sphinx==5.3.0",
"docutils==0.18.1",
"sphinx-rtd-theme==1.2.2", # Read-The-Docs theme for Sphinx
"nbsphinx==0.9.2", # Parses Jupyter notebooks
"nbsphinx-link==1.3.0", # Adds Jupyter NBs to Sphinx source root
"sphinx-gallery==0.13.0", # Builds an HTML version of a Python script and puts it into a gallery
"sphinxcontrib-apidoc==0.3.0", # More easily document our API
"sphinxext-opengraph==0.8.2", # Generates OpenGraph metadata to make good-looking cards on social media
"sphinx-needs==1.2.2", # Requirements traceability matrices for QA
"sphinxcontrib-plantuml==0.25", # UML support in sphinx-needs
"pandoc", # Must be in the path (to convert file formats)
"ipykernel==6.25.1", # iPython kernel to run Jupyter notebooks
"pylint==2.17.5", # Generates UML diagrams
"Jinja2==3.0.3", # Used in numpydoc and nbconvert
"sphinxcontrib-jquery==4.1", # Handle missing jquery errors
]

[project.scripts]
armi = "armi.__main__:main"
Expand Down
3 changes: 1 addition & 2 deletions tox.ini
Expand Up @@ -18,10 +18,9 @@ commands =
allowlist_externals =
/usr/bin/git
/usr/bin/make
deps=
-r{toxinidir}/doc/requirements-docs.txt
changedir = doc
commands =
pip install -e ..[memprof,mpi,test,docs]
git submodule init
git submodule update
make html
Expand Down

0 comments on commit eb0e12b

Please sign in to comment.