mkdocs-rtd
A fork of mkdocs readthedocs theme to make it work better, especially with mkapi.
Why just use extra_css and extra_javascript?
- The javascript written in
theme.jsshipped with the original theme has problems expanding the sidebar items and it's not easy to fix it only usingextra_javascript.
Installation
pip install -U mkdocs-rtd
Usage
theme:
name: rtd
All options are the same when using the original theme (readthedocs). See also:
https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs
Modifications
- Add social icons (only Github supported now) to the top right corner of the page.
- Adjust some styles
- Open external links in new tab by default
- Do not reset side nav items when url hash is
#or empty - Make search box sticky
- Add css support for
pymdownx.blocks.tab(must usealternate_style: true) - Set
ignoreUnescapedHTMLtotrueforhljs - Keep current sidebar item always in view when scrolling
Metadata
Release files for mkdocs-rtd 0.0.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_rtd-0.0.15.tar.gz | 2.8 MB | Without provenance | Details for mkdocs_rtd-0.0.15.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_rtd-0.0.15-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_rtd-0.0.15-py3-none-any.whl |
Total release size: 5.6 MB
Release files / mkdocs_rtd-0.0.15.tar.gz
| Download URL | mkdocs_rtd-0.0.15.tar.gz |
|---|---|
| Size | 2.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a92ca9319bbcb5e042bb75a45117097827b166eae478ca1cfb7c4db61653af63
|
|
BLAKE2b-256 checksum How to use checksums |
c02840b973e6de72c904312cc78afe3fbde3bd8c9a4ef435430493b8b494610d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.8.10 Linux/5.15.0-1068-azure
|
Release files / mkdocs_rtd-0.0.15-py3-none-any.whl
| Download URL | mkdocs_rtd-0.0.15-py3-none-any.whl |
|---|---|
| Size | 2.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d8bc7b97e03a8ef5a70bac225edd5fbbfa5bd25bec72360c75b611cc7f64cb0a
|
|
BLAKE2b-256 checksum How to use checksums |
88538ddc4dd326ef4bdf5109bbf96c2a6baaec5e05aab74fae8adac7cac24e84
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.8.10 Linux/5.15.0-1068-azure
|
Security for mkdocs-rtd 0.0.15
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.