Skip to content

Commit

Permalink
add mike as versioning provider for python docs (#1375)
Browse files Browse the repository at this point in the history
Signed-off-by: bossenti <bossenti@posteo.de>
  • Loading branch information
bossenti committed Mar 6, 2023
1 parent cf85c2a commit 2289193
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 14 deletions.
34 changes: 21 additions & 13 deletions streampipes-client-python/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ extra:
- icon: fontawesome/brands/github-alt
link: https://github.com/apache/streampipes

version:
provider: mike

# Extensions
markdown_extensions:
- admonition
Expand All @@ -51,8 +54,8 @@ markdown_extensions:
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
use_pygments: true
pygments_lang_class: true
use_pygments: true
pygments_lang_class: true

plugins:
- awesome-pages
Expand All @@ -71,19 +74,24 @@ plugins:
docstring_section_style: spacy
show_source: False
merge_init_into_class: True
- mike:
canonical_version: 'latest'
version_selector: true
css_dir: css
javascript_dir: js

extra_css:
- stylesheets/extra.css

nav:
- Home: index.md
- Getting Started:
- First Steps: getting-started/first-steps.md
- Developing & Contributing: getting-started/developing.md
- Quickstart: getting-started/quickstart.md
- Examples:
- Introduction to the StreamPipes Python Client: examples/1-introduction-to-streampipes-python-client.ipynb
- Extracting Data from the StreamPipes Data Lake: examples/2-extracting-data-from-the-streampipes-data-lake.ipynb
- Exploring Live Data from a StreamPipes Data Stream: examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb
- Applying Online Machine Learning on a StreamPipes Data Stream: examples/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb
- Reference: reference/*
- Home: index.md
- Getting Started:
- First Steps: getting-started/first-steps.md
- Developing & Contributing: getting-started/developing.md
- Quickstart: getting-started/quickstart.md
- Examples:
- Introduction to the StreamPipes Python Client: examples/1-introduction-to-streampipes-python-client.ipynb
- Extracting Data from the StreamPipes Data Lake: examples/2-extracting-data-from-the-streampipes-data-lake.ipynb
- Exploring Live Data from a StreamPipes Data Stream: examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb
- Applying Online Machine Learning on a StreamPipes Data Stream: examples/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb
- Reference: reference/*
3 changes: 2 additions & 1 deletion streampipes-client-python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@
"mkdocs-gen-files==0.4.0",
"mkdocs-literate-nav==0.6.0",
"numpydoc==1.5.0",
"mkdocs-jupyter==0.22.0 "
"mkdocs-jupyter==0.22.0",
"mike @ git+https://github.com/jimporter/mike.git@872f72def32f588908f8251fe512189e0c41f4e2"
]

here = os.path.abspath(os.path.dirname(__file__))
Expand Down

0 comments on commit 2289193

Please sign in to comment.