Skip to content

Use theme release 0.5.0rc1 for docs #7037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 16, 2020
Merged

Use theme release 0.5.0rc1 for docs #7037

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0c02f1
Use theme release 0.5.0rc2 for docs
agjohnson May 6, 2020
096ec95
Merge branch 'master' of github.com:readthedocs/readthedocs.org into …
ericholscher Jun 15, 2020
3474355
Fix up requirements a bit more
ericholscher Jun 15, 2020
9c143b1
Add comments to each requirements file.
ericholscher Jun 15, 2020
4c9f90f
Remove double requirement
ericholscher Jun 16, 2020
f151e56
Use docs reqs explicitly
ericholscher Jun 16, 2020
d3de8a6
Add smile to rstcheck ignore
ericholscher Jun 16, 2020
9e6b4f4
Hack ci for now
ericholscher Jun 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ formats: all
sphinx:
configuration: docs/conf.py
python:
install:
- requirements: requirements/local-docs-build.txt
install:
- requirements: requirements/pip.txt
- requirements: requirements/docs.txt
2 changes: 1 addition & 1 deletion docs/development/docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Follow the instructions just up to the point of activating the virtual environme

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

pip install -r requirements/local-docs-build.txt
pip install -r requirements/docs.txt

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

Expand Down
14 changes: 7 additions & 7 deletions requirements/local-docs-build.txt → requirements/docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
-r pip.txt
# Packages required to build docs, independent of application dependencies

# Base packages
Sphinx==3.0.4

# doctuils==0.15 produces this error
# File "python3.6/site-packages/docutils/parsers/rst/states.py", line 882, in interpreted
Expand All @@ -10,18 +10,15 @@
# AttributeError: 'str' object has no attribute 'rawsource'
docutils==0.14 # pyup: ignore

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

readthedocs-sphinx-search==0.1.0rc1

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


Pygments==2.6.1

mkdocs==1.1
Expand All @@ -34,3 +31,6 @@ sphinx-prompt==1.0.0
sphinx-notfound-page==0.4
commonmark==0.9.1
recommonmark==0.6.0

# Linting
rstcheck==3.3.1
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ commands =

[testenv:docs-lint]
description = run linter (rstcheck) to ensure there aren't errors on our docs
deps = -r{toxinidir}/requirements/docs-lint.txt
deps = -r{toxinidir}/requirements/docs.txt
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we still need rstcheck?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it's already in docs.txt -- so we should remove the docs-lint file.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(removed in a commit)

changedir = {toxinidir}/docs
commands =
rstcheck -r .
Expand Down