Skip to content

Commit e293351

Browse files
committed
Configure Read The Docs in the repository
Also updates the MkDocs `pages:` setting to `nav:`, which appears to have replaced it in later versions.
1 parent 11e9737 commit e293351

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed

.readthedocs.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-20.04
11+
tools:
12+
python: "3.9"
13+
14+
mkdocs:
15+
configuration: mkdocs.yml
16+
17+
# Optionally declare the Python requirements required to build your docs
18+
python:
19+
install:
20+
- requirements: doc/requirements.txt

doc/requirements.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# pip requirements file for MkDocs, used by Read The Docs
2+
#
3+
# See:
4+
#
5+
# The Read The Docs recommendation to 'pin' the MkDocs version used to build
6+
# documentation:
7+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#pinning-dependencies
8+
#
9+
# The pip guide to its requirements file format:
10+
# https://pip.pypa.io/en/stable/reference/requirements-file-format/
11+
#
12+
# Latest version of MkDocs as at 2 August 2022
13+
mkdocs==1.3.1

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ extra_css:
1212
extra_javascript:
1313
- js/searchhack.js
1414

15-
pages:
15+
nav:
1616
- Home: README.md
1717
- Changelog: ChangeLog.md
1818
- Tool documentation:

0 commit comments

Comments
 (0)