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.2.tar.gz
(2.8 MB
view details)
Built Distribution
File details
Details for the file mkdocs_rtd-0.0.2.tar.gz.
File metadata
- Download URL: mkdocs_rtd-0.0.2.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 | 40a89102a3712b1571096820c840a19b5363572a1722866b00a7bbeb6672adab |
|
| MD5 | 148cc9c6f2d361a4753e14393a615f8b |
|
| BLAKE2b-256 | 0693608a581d54fa120b14548ac719dddaa261bff2fe05fcdf164991e672a488 |
File details
Details for the file mkdocs_rtd-0.0.2-py3-none-any.whl.
File metadata
- Download URL: mkdocs_rtd-0.0.2-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 | f92f91bb28b21b76723761a3d9bae2b74c0ea403ec3634ccde845c6a096c320c |
|
| MD5 | 8e01ba57ba8294cfe40aa33a504b07d5 |
|
| BLAKE2b-256 | feccbd60850c6bd819bb960367693d9016681a7c093bc1aa1b2f77f6349eee42 |
