Skip to content

Commit

Permalink
Only link Python and Rich types when building full docs
Browse files Browse the repository at this point in the history
It looks like mkdocstrings will fail out if it can't download the inv files.
Unless there's a setting where you can tell it "try, but if you can't grab
them just don't try and create links" the approach here seems reasonable and
has the same effect.

#2629 (comment)
for reference.
  • Loading branch information
davep committed May 29, 2023
1 parent 806a666 commit d4eb0a0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 0 additions & 3 deletions mkdocs-common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@ plugins:
default_handler: python
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://rich.readthedocs.io/en/stable/objects.inv
options:
show_signature_annotations: false
separate_signature: true
Expand Down
6 changes: 6 additions & 0 deletions mkdocs-online.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,9 @@ plugins:
- categories
- release
- tags
mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://rich.readthedocs.io/en/stable/objects.inv

0 comments on commit d4eb0a0

Please sign in to comment.