ReadTheDocs version warning MkDocs plugin replace placeholder text with warning banner for specific versions if deployed on Readthedocs
Project description
ReadTheDocs version warning MkDocs plugin
"ReadTheDocs version warning MkDocs plugin" is a very basic mkdocs plugin
that replace placeholder text (### VERSION-WARNING-BANNER-PLACEHOLDER ###
) in the theme template with warning admonition.
Configuration
plugins:
- readthedocs-version-warning:
project_id: "000000"
show_on_versions:
- latest
project_id
- Id of the target project on ReadTheDocs.
From this project will be used the default version to render link to the stable version.
show_on_versions
- List of versions on which the banner should appear.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file readthedocs-version-warning-mkdocs-plugin-0.0.1.tar.gz
.
File metadata
- Download URL: readthedocs-version-warning-mkdocs-plugin-0.0.1.tar.gz
- Upload date:
- Size: 2.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 478f903895156ac83b335810e8bfce1547e945fbff60fc3dd51ec9c1846735a6 |
|
MD5 | a608784c29b2033625231df5e7d4ec67 |
|
BLAKE2b-256 | 3cbd3e554fd31a7062e14a6a89700a3f3844b06c29a37365ca1a80f6726f7c2f |
File details
Details for the file readthedocs_version_warning_mkdocs_plugin-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: readthedocs_version_warning_mkdocs_plugin-0.0.1-py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1759a1f02958774a90164c303d3d155ec22fc93ba4e2c01265a55b6e3d218b09 |
|
MD5 | e7ed0c5c962cfcb082127ad0218cbb16 |
|
BLAKE2b-256 | 67414fbc7ec28cf70e90815e9069439aea9f4a414031bdd6e96b12ff32a552e8 |