File tree 4 files changed +12
-11
lines changed
4 files changed +12
-11
lines changed Original file line number Diff line number Diff line change @@ -3,5 +3,6 @@ formats: all
3
3
sphinx :
4
4
configuration : docs/conf.py
5
5
python :
6
- install :
7
- - requirements : requirements/local-docs-build.txt
6
+ install :
7
+ - requirements : requirements/pip.txt
8
+ - requirements : requirements/docs.txt
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ Follow the instructions just up to the point of activating the virtual environme
10
10
11
11
Next, install the documentation dependencies using ``pip `` (make sure you are inside of the virtual environment)::
12
12
13
- pip install -r requirements/local- docs-build .txt
13
+ pip install -r requirements/docs.txt
14
14
15
15
This installs ``Sphinx ``, amongst other things.
16
16
Original file line number Diff line number Diff line change 1
- -r pip.txt
1
+ # Packages required to build docs, independent of application dependencies
2
2
3
- # Base packages
3
+ Sphinx==3.0.4
4
4
5
5
# doctuils==0.15 produces this error
6
6
# File "python3.6/site-packages/docutils/parsers/rst/states.py", line 882, in interpreted
10
10
# AttributeError: 'str' object has no attribute 'rawsource'
11
11
docutils==0.14 # pyup: ignore
12
12
13
- sphinx_rtd_theme==0.4.3
13
+ sphinx_rtd_theme==0.5.0rc2
14
14
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
18
16
19
17
# Test out in-doc search
20
18
git+https://github.com/readthedocs/readthedocs-sphinx-search@master
21
19
22
20
# Test out hoverxref
23
21
git+https://github.com/readthedocs/sphinx-hoverxref@master
24
22
25
-
26
23
Pygments==2.6.1
27
24
28
25
mkdocs==1.1
@@ -34,3 +31,6 @@ sphinx-prompt==1.0.0
34
31
sphinx-notfound-page==0.4
35
32
commonmark==0.9.1
36
33
recommonmark==0.6.0
34
+
35
+ # Linting
36
+ rstcheck==3.3.1
Original file line number Diff line number Diff line change @@ -48,7 +48,7 @@ commands =
48
48
49
49
[testenv:docs-lint]
50
50
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
52
52
changedir = {toxinidir}/docs
53
53
commands =
54
54
rstcheck -r .
You can’t perform that action at this time.
0 commit comments