Skip to content

Do not build documentation in Circle CI, Read the Docs handles that 💯 #9788

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 3 commits into from
Dec 13, 2022
Merged

Do not build documentation in Circle CI, Read the Docs handles that 💯 #9788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02b33c7
Do not build documentation in Circle CI, Read the Docs handles that -…
benjaoming Dec 8, 2022
bdf3087
Merge branch 'main' of github.com:readthedocs/readthedocs.org into re…
benjaoming Dec 8, 2022
20765a8
Add comments to Tox environments that aren't run in CI
benjaoming Dec 10, 2022
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
2 changes: 0 additions & 2 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ jobs:
- run: tox -e pre-commit
- run: tox -e migrations
- run: tox -e lint
- run: tox -e docs
- run: tox -e docs-dev
- run: scripts/circle/install_node.sh
- run:
name: Add node to the path
Expand Down
1 change: 1 addition & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ formats: all

sphinx:
configuration: docs/conf.py
fail_on_warning: true

python:
install:
Expand Down
2 changes: 2 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ allowlist_externals =
sh
git

# This is NOT run in CI builds, it can be used locally for convenience
[testenv:docs]
description = Build readthedocs user documentation
changedir = {toxinidir}/docs
Expand All @@ -39,6 +40,7 @@ setenv =
commands =
sphinx-build -W --keep-going -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

# This is NOT run in CI builds, it can be used locally for convenience
[testenv:docs-dev]
description = Build readthedocs developer documentation
changedir = {toxinidir}/docs
Expand Down