Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Jump to bottom

Switching to & configuring autoapi.extension for build docs #242

Merged
merged 3 commits into from
Sep 13, 2023
Merged

Switching to & configuring autoapi.extension for build docs #242

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a2c7e8
Adding Sphinx extra requirements to .readthedocs.yaml
ns-rse Sep 13, 2023
7088393
Switching to & configuring autoapi.extensionfor building docs
ns-rse Sep 13, 2023
6254156
[pre-commit.ci] Fixing issues with pre-commit
pre-commit-ci[bot] Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lib/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
from importlib.metadata import version
from pathlib import Path

sys.path.insert(0, os.path.abspath(".."))

Expand Down Expand Up @@ -44,6 +45,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"autoapi.extension",
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx.ext.viewcode",
Expand Down Expand Up @@ -86,6 +88,13 @@
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None

# -- autoapi configuration ---------------------------------------------------

# Language of source code to parse
autoapi_type = "python"

# Source code to parse to generate API docs relative to 'docs/source' directory
autoapi_dirs = [Path("../pgfinder/")]

# -- Options for HTML output -------------------------------------------------

Expand Down
Loading