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.js
shipped 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
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
mkdocs_rtd-0.0.1.tar.gz
(2.8 MB
view details)
Built Distribution
File details
Details for the file mkdocs_rtd-0.0.1.tar.gz
.
File metadata
- Download URL: mkdocs_rtd-0.0.1.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 | 4b0e28bf2222782f2357080a04a9ceaddbfb01988a74a2e4665a54acdba77a4b |
|
MD5 | ac09aaa93bef63e8555611c1ea8c1d0b |
|
BLAKE2b-256 | 1f0943a50dce7cc47e4f09ac1ef8faab5dc19231cc9a2a8e49c81802a1731630 |
File details
Details for the file mkdocs_rtd-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: mkdocs_rtd-0.0.1-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 | 7917afb1418317ead307f75432c282084ec4891cf99fe18df36cdcef9539a4f3 |
|
MD5 | 2d3dff02c400e45822f329e45ed8affa |
|
BLAKE2b-256 | 3d109147ba87179c22cdba6170c9c5b5fc896be48e7934ace3b575607f1c93f4 |