Skip to content

Commit 745d47d

Browse files
authored
document new support for readthedocs
1 parent 7b1054f commit 745d47d

3 files changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
## Features :star2:
1414

1515
- Support for [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme, including features like instant loading and dark color themes.
16+
- Support for [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme
1617
- Support for pagination in PDFs.
1718
- Many options to customize appearance
1819
- Option to add a cover page
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
site_name: Test
2+
3+
theme:
4+
name: readthedocs
5+
6+
plugins:
7+
- print-site:
8+
add_to_navigation: true
9+
10+
nav:
11+
- Home: index.md
12+
- Page Z: z.md
13+
- Page A: a.md

tests/test_building.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@ def text_in_page(tmp_proj, page_path, text):
116116

117117

118118
# Tests ####
119+
def test_readthedocs(tmp_path):
120+
"""
121+
Test.
122+
"""
123+
check_build(tmp_path, "basic/mkdocs_readthedocs.yml")
119124

120125

121126
def test_windmill(tmp_path):

0 commit comments

Comments
 (0)