Skip to content

Commit

Permalink
DOC: Fix Sphinx documentation
Browse files Browse the repository at this point in the history
Fix Sphinx documentation.
  • Loading branch information
jhlegarreta committed Oct 17, 2023
1 parent f9d47da commit d327c4a
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ build:
apt_packages:
- libblas-dev
- liblapack-dev
jobs:
pre_build:
- sphinx-apidoc -f -o doc .

# Build documentation in the doc/ directory with Sphinx
sphinx:
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = doc
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
4 changes: 2 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Welcome to the whitematteranalysis documentation!

.. toctree::
:maxdepth: 1
:caption: Reference

bin
utilities
modules

0 comments on commit d327c4a

Please sign in to comment.