Skip to content

Commit

Permalink
Feature(docs): Add inventory file for intersphinx support.
Browse files Browse the repository at this point in the history
  • Loading branch information
onegreyonewhite committed Nov 7, 2024
1 parent 9016efe commit 1b7dd8d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ markdown_extensions:
- toc:
anchorlink: True

plugins:
- mkdocstrings:
enable_inventory: true

nav:
- Home: 'index.md'
- Tutorial:
Expand Down
3 changes: 3 additions & 0 deletions requirements/requirements-documentation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ mkdocs==1.6.0

# pylinkvalidator to check for broken links in documentation.
pylinkvalidator==0.3

# to generate objects.inv
mkdocstrings-python~=1.12.2

0 comments on commit 1b7dd8d

Please sign in to comment.