Skip to content

Commit c0c02f1

Browse files
committed
Use theme release 0.5.0rc2 for docs
* Upgrade Sphinx to 3.0.4 * Redo some of our doc requirements files to make them less complicated
1 parent aa1bf7a commit c0c02f1

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

.readthedocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ formats: all
33
sphinx:
44
configuration: docs/conf.py
55
python:
6-
install:
7-
- requirements: requirements/local-docs-build.txt
6+
install:
7+
- requirements: requirements/pip.txt
8+
- requirements: requirements/docs.txt

docs/development/docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Follow the instructions just up to the point of activating the virtual environme
1010

1111
Next, install the documentation dependencies using ``pip`` (make sure you are inside of the virtual environment)::
1212

13-
pip install -r requirements/local-docs-build.txt
13+
pip install -r requirements/docs.txt
1414

1515
This installs ``Sphinx``, amongst other things.
1616

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
-r pip.txt
1+
# Packages required to build docs, independent of application dependencies
22

3-
# Base packages
3+
Sphinx==3.0.4
44

55
# doctuils==0.15 produces this error
66
# File "python3.6/site-packages/docutils/parsers/rst/states.py", line 882, in interpreted
@@ -10,19 +10,16 @@
1010
# AttributeError: 'str' object has no attribute 'rawsource'
1111
docutils==0.14 # pyup: ignore
1212

13-
sphinx_rtd_theme==0.4.3
13+
sphinx_rtd_theme==0.5.0rc2
1414
sphinx-tabs==1.1.13
15-
# Required to avoid Transifex error with reserved slug
16-
# https://github.com/sphinx-doc/sphinx-intl/pull/27
17-
git+https://github.com/agjohnson/sphinx-intl.git@7b5c66bdb30f872b3b1286e371f569c8dcb66de5#egg=sphinx-intl
15+
sphinx-intl==2.0.1
1816

1917
# Test out in-doc search
2018
git+https://github.com/readthedocs/readthedocs-sphinx-search@master
2119

2220
# Test out hoverxref
2321
git+https://github.com/readthedocs/sphinx-hoverxref@master
2422

25-
2623
Pygments==2.6.1
2724

2825
mkdocs==1.1
@@ -34,3 +31,6 @@ sphinx-prompt==1.0.0
3431
sphinx-notfound-page==0.4
3532
commonmark==0.9.1
3633
recommonmark==0.6.0
34+
35+
# Linting
36+
rstcheck==3.3.1

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ commands =
4848

4949
[testenv:docs-lint]
5050
description = run linter (rstcheck) to ensure there aren't errors on our docs
51-
deps = -r{toxinidir}/requirements/docs-lint.txt
51+
deps = -r{toxinidir}/requirements/docs.txt
5252
changedir = {toxinidir}/docs
5353
commands =
5454
rstcheck -r .

0 commit comments

Comments
 (0)