Skip to content

Commit

Permalink
Merge pull request #893 from samdoran/backport/888/release_2.0
Browse files Browse the repository at this point in the history
[release_2.0] Add configuration for Read the Docs build and pin docs requirements (#888)

Backport of #888 for Ansible Runner 2.0.

Reviewed-by: David Shrewsbury <None>
Reviewed-by: None <None>
  • Loading branch information
ansible-zuul[bot] committed Oct 29, 2021
2 parents ca7010f + 4f93f06 commit bba1641
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 4 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,19 @@
version: 2

formats:
- epub
- pdf

build:
os: ubuntu-20.04
tools:
python: '3.10'

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

python:
install:
- requirements: docs/requirements.txt
5 changes: 5 additions & 0 deletions docs/requirements.in
@@ -0,0 +1,5 @@
ansible-core
pbr
pexpect
six
sphinx
36 changes: 33 additions & 3 deletions docs/requirements.txt
@@ -1,3 +1,33 @@
pbr
sphinx
ansible-core
alabaster==0.7.12
ansible-core==2.11.6
Babel==2.9.1
certifi==2021.10.8
cffi==1.15.0
charset-normalizer==2.0.7
cryptography==35.0.0
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
MarkupSafe==2.0.1
packaging==21.0
pbr==5.6.0
pexpect==4.8.0
ptyprocess==0.7.0
pycparser==2.20
Pygments==2.10.0
pyparsing==3.0.1
pytz==2021.3
PyYAML==6.0
requests==2.26.0
resolvelib==0.5.5
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
urllib3==1.26.7
3 changes: 2 additions & 1 deletion tox.ini
Expand Up @@ -27,5 +27,6 @@ commands=
[testenv:docs]
description = Build documentation
deps = -r{toxinidir}/docs/requirements.txt
skip_install = True
commands =
sphinx-build -E -W -d docs/build/doctrees -b html docs docs/build/html
sphinx-build -T -E -W --keep-going {tty:--color} -j auto -d docs/build/doctrees -b html docs docs/build/html

0 comments on commit bba1641

Please sign in to comment.