Skip to content

Commit

Permalink
docs: update reference API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Morley-Short committed May 3, 2024
1 parent c00c970 commit a4e1c6d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 21 deletions.
20 changes: 0 additions & 20 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,11 @@
# API reference

::: bartiq
handler: python
options:
show_source: false

::: bartiq.compilation
handler: python
options:
show_source: false

::: bartiq.precompilation
handler: python
options:
show_source: false

::: bartiq.symbolics
handler: python
options:
show_source: false

::: bartiq.routing
handler: python
options:
show_source: false

::: bartiq.errors
handler: python
options:
show_source: false
12 changes: 11 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,17 @@ plugins:
- link-marker
- open-in-new-tab
- search
- mkdocstrings
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_source: false
separate_signature: true
line_length: 60
modernize_annotations: true
show_signature_annotations: true
show_root_heading: true
- mkdocs-jupyter:
include_source: True

Expand Down

0 comments on commit a4e1c6d

Please sign in to comment.