Skip to content

Commit

Permalink
Merge pull request #28 from jepler/test-docs
Browse files Browse the repository at this point in the history
More doc improvements
  • Loading branch information
jepler authored Jul 20, 2024
2 parents 37418fe + 5a1101f commit 593a852
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/_ext/custom_autodoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,8 @@ def setup(app: Sphinx) -> None:
"autodoc-process-docstring",
remove_first_line_in_module_docstring,
)

return {
"parallel_read_safe": True,
"parallel_write_safe": True,
}
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import os
import sys
import pathlib
import subprocess

sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
sys.path.append(str(pathlib.Path(__file__).parent / "_ext"))
Expand All @@ -34,7 +35,7 @@
author = 'Jeff Epler'

# The full version, including alpha/beta/rc tags
release = '1.1.0'
version = release = subprocess.check_output(["python", "-m", "setuptools_scm"], cwd="..", encoding="ascii").strip()


# -- General configuration ---------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ coverage
mypy; implementation_name=="cpython"
pre-commit
setuptools>=45
setuptools_scm[toml]>=6.0
sphinx
sphinx-autodoc-typehints
sphinx-rtd-theme
Expand Down

0 comments on commit 593a852

Please sign in to comment.