Skip to main content

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for readthedocs-version-warning-mkdocs-plugin, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size readthedocs_version_warning_mkdocs_plugin-0.0.1-py3-none-any.whl (4.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size readthedocs-version-warning-mkdocs-plugin-0.0.1.tar.gz (2.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page