A fork of mkdocs readthedocs theme to make it work with mkapi
Project description
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
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
mkdocs_rtd-0.0.0.tar.gz
(2.8 MB
view details)
Built Distribution
File details
Details for the file mkdocs_rtd-0.0.0.tar.gz.
File metadata
- Download URL: mkdocs_rtd-0.0.0.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.8.10 Linux/5.15.0-1046-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f6a05984d774ee3c7662bb65b520eaa9cdf1cf6a6f156602201153d21e0b4f8d |
|
| MD5 | 873f11cac5a4c222c19da70e3f7e0a47 |
|
| BLAKE2b-256 | 738502a9b9925ee5d0fbc7fcccdae7935f3ed71ac4320ed78ab07ed59bc96b85 |
File details
Details for the file mkdocs_rtd-0.0.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_rtd-0.0.0-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.8.10 Linux/5.15.0-1046-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e72df904b0041ce0e00afaa290869b2abcff33301f00df9b6b4bd6f90e57d412 |
|
| MD5 | a29c5a6f011ced3372fc9eca1234c4e6 |
|
| BLAKE2b-256 | 11bbdccdeb0b76e4148d8a46cfdf559619d3c0138e1faca277050f3253653730 |
