Skip to content

Commit

Permalink
Add default options for mkdocstrings #434
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianK13 committed Aug 7, 2023
1 parent e077a35 commit 7a8c7da
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ plugins:
- mkdocstrings:
default_handler: python
docstring_style: numpy
handlers:
python:
options:
show_root_heading: true
show_source: false
docstring_style: numpy
docstring_section_style: spacy
- include-markdown


Expand Down Expand Up @@ -58,14 +65,16 @@ markdown_extensions:
emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
- open-mastr: index.md
- Home: index.md
- Getting Started: getting_started.md
- The dataset: dataset.md
- Development:
- Contributing: development/contributing_mirror.md
- Release Procedure: development/release_procedure_mirror.md
- Changelog: development/changelog_mirror.md
- API Reference: reference.md
- API Reference:
- Basic Usage: reference/basic.md
- Advanced Usage of the MaStR SOAP-API: reference/advanced.md

repo_url: https://github.com/OpenEnergyPlatform/open-MaStR
site_description: A package that provides an interface for downloading and processing the data of the Marktstammdatenregister (MaStR)
Expand Down

0 comments on commit 7a8c7da

Please sign in to comment.