Skip to content

Commit

Permalink
Add autogenerated API Reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmalinmayor committed Feb 11, 2025
1 parent f419d66 commit 02efe06
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
22 changes: 20 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,23 @@ extra:

plugins:
- search
- mkdocs-autoapi
- mkdocstrings
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
options:
docstring_section_style: list # or "table"
docstring_style: "google"
filters: ["!^_"]
heading_level: 1
merge_init_into_class: true
parameter_headings: true
separate_signature: true
show_root_heading: true
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
summary: true
- api-autonav:
modules: ['src/funtracks']
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ dependencies =[
]
[project.optional-dependencies]
testing =["pytest", "pytest-cov"]
docs = ["mkdocs-material", "mike", "mkdocstrings[python]", "mkdocs-autoapi"]
docs = ["mkdocs-material", "mike", "mkdocstrings[python]", "mkdocs-api-autonav"]
dev = ["ruff", "pre-commit", "mypy"]
all = ["funtracks[testing,docs,dev]"]

Expand Down

0 comments on commit 02efe06

Please sign in to comment.