Skip to content

Commit 6cc7d3a

Browse files
committed
Include RTD configuration file and bump Sphinx version
1 parent b108b71 commit 6cc7d3a

File tree

3 files changed

+27
-2
lines changed

3 files changed

+27
-2
lines changed

.readthedocs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# .readthedocs.yml
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+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: doc/source/conf.py
11+
12+
# Build documentation with MkDocs
13+
#mkdocs:
14+
# configuration: mkdocs.yml
15+
16+
# Optionally build your docs in additional formats such as PDF
17+
formats:
18+
- pdf
19+
20+
# Optionally set the version of Python and requirements required to build your docs
21+
python:
22+
version: 3.7
23+
install:
24+
- requirements: test-requirements.txt
25+
- requirements: requirements.txt

test-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ mock>=1.2
2222
pytest
2323
pytest-cov
2424

25-
sphinx>=1.6.2 # BSD
25+
sphinx>=4.0.2
2626
sphinx_rtd_theme
2727
recommonmark
2828
reno>=2.5.0 # Apache-2.0

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ skipsdist = True
66
[testenv]
77
usedevelop = True
88
basepython = python3
9+
install_command = pip install -U {opts} {packages}
910
whitelist_externals =
1011
find
1112
rm
12-
install_command = pip install -U {opts} {packages}
1313
setenv =
1414
VIRTUAL_ENV={envdir}
1515
LC_ALL=en_US.utf-8

0 commit comments

Comments
 (0)