You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/03/06 20:51:01 UTC
[streampipes] 01/02: add mike as versioning provider for python docs (#1375)
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch 1375-versioning-for-python-docs
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 2289193ed8bc5eab30719ee2349255d7298c6cd0
Author: bossenti <bo...@posteo.de>
AuthorDate: Mon Mar 6 21:38:00 2023 +0100
add mike as versioning provider for python docs (#1375)
Signed-off-by: bossenti <bo...@posteo.de>
---
streampipes-client-python/mkdocs.yml | 34 +++++++++++++++++++++-------------
streampipes-client-python/setup.py | 3 ++-
2 files changed, 23 insertions(+), 14 deletions(-)
diff --git a/streampipes-client-python/mkdocs.yml b/streampipes-client-python/mkdocs.yml
index e73ef072c..373d76c86 100644
--- a/streampipes-client-python/mkdocs.yml
+++ b/streampipes-client-python/mkdocs.yml
@@ -38,6 +38,9 @@ extra:
- icon: fontawesome/brands/github-alt
link: https://github.com/apache/streampipes
+ version:
+ provider: mike
+
# Extensions
markdown_extensions:
- admonition
@@ -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
@@ -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/*
diff --git a/streampipes-client-python/setup.py b/streampipes-client-python/setup.py
index cb8f767db..83ab524d5 100644
--- a/streampipes-client-python/setup.py
+++ b/streampipes-client-python/setup.py
@@ -63,7 +63,8 @@ docs_packages = [
"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__))