Skip to content

Commit

Permalink
napoleon extension is distributed with sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
prs513rosewood committed Dec 21, 2022
1 parent c79c906 commit b7dc557
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@ jobs:
run: |
sudo apt-get update -qy
sudo apt-get install -y python3-dev python3-pip libxml2-dev libxslt-dev zlib1g-dev meson
sudo pip install --upgrade sphinxcontrib-napoleon sphinx_rtd_theme
- name: install_package
run: |
sudo pip install .[test]
sudo pip install .[docs]
# Standard drop-in approach that should work for most people.
- name: build_doc
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinxcontrib.napoleon',
'sphinx.ext.napoleon',
'sphinx.ext.autosummary',
]

Expand Down
8 changes: 3 additions & 5 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
numpy>=1.5.0
ase>=3.9.0
#scipy>=0.10.0
sphinxcontrib-napoleon
sphinx_rtd_theme
numpy>=1.16.0
ase>=3.16.0
sphinx_rtd_theme
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ test = [
"pytest",
"sympy"
]
docs = [
"sphinx",
"sphinx-rtd-theme",
]

[project.urls]
documentation = "http://libatoms.github.io/matscipy/"
Expand Down

0 comments on commit b7dc557

Please sign in to comment.