Skip to content

Commit

Permalink
Merge pull request #86 from gandersen101/documentation/update-readthe…
Browse files Browse the repository at this point in the history
…docs-config

Updating readthedocs config
  • Loading branch information
gandersen101 committed Mar 12, 2024
2 parents 7638605 + 13ef252 commit f50bd2a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
9 changes: 8 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
version: 2

sphinx:
configuration: docs/conf.py

build:
os: ubuntu-22.04
tools:
python: "3.11"

formats: all

python:
version: 3.8
install:
- requirements: docs/requirements.txt
- path: .
8 changes: 2 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
"""Sphinx configuration."""
project = "spaczz"
author = "Grant Andersen"
copyright = f"2023, {author}"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints",
]
copyright = f"2024, {author}"
extensions = ["sphinx.ext.autodoc", "sphinx_autodoc_typehints", "sphinx.ext.napoleon"]
napoleon_include_special_with_doc = True
napoleon_custom_sections = [("Match Settings", "params_style")]
napoleon_type_aliases = {"FlexType": "int | Literal['default', 'min', 'max']"}

0 comments on commit f50bd2a

Please sign in to comment.