Skip to content

Commit e74e12d

Browse files
committed
Add a requirements.txt for Read The Docs
1 parent bf99625 commit e74e12d

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

.readthedocs.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ mkdocs:
1515
configuration: mkdocs.yml
1616

1717
# Optionally declare the Python requirements required to build your docs
18-
# python:
19-
# install:
20-
# - requirements: doc/requirements.txt
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+
# Version used in the stable branch
13+
mkdocs==0.17.3

0 commit comments

Comments
 (0)