diff options
| author | Don Naro <dnaro@redhat.com> | 2023-10-24 18:53:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-24 18:53:41 +0200 |
| commit | 94703ccf84edff82f4f9d83afc47f566ea007852 (patch) | |
| tree | 556f8690a67577a59b70327bb948951fe6223ef9 | |
| parent | Alt text for Execution Env section of Userguide (#14576) (diff) | |
| download | awx-94703ccf84edff82f4f9d83afc47f566ea007852.tar.xz awx-94703ccf84edff82f4f9d83afc47f566ea007852.zip | |
Pip compile docsite requirements (#14449)
Co-authored-by: Sviatoslav Sydorenko <578543+webknjaz@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
| -rw-r--r-- | .pip-tools.toml | 5 | ||||
| -rw-r--r-- | docs/docsite/requirements.in | 7 | ||||
| -rw-r--r-- | docs/docsite/requirements.txt | 75 | ||||
| -rw-r--r-- | tox.ini | 14 |
4 files changed, 97 insertions, 4 deletions
diff --git a/.pip-tools.toml b/.pip-tools.toml new file mode 100644 index 0000000000..c1f6c7ad65 --- /dev/null +++ b/.pip-tools.toml @@ -0,0 +1,5 @@ +[tool.pip-tools] +resolver = "backtracking" +allow-unsafe = true +strip-extras = true +quiet = true diff --git a/docs/docsite/requirements.in b/docs/docsite/requirements.in new file mode 100644 index 0000000000..580df8eb60 --- /dev/null +++ b/docs/docsite/requirements.in @@ -0,0 +1,7 @@ +# This requirements file is used for AWX latest doc builds. + +sphinx # Tooling to build HTML from RST source. +sphinx-ansible-theme # Ansible community theme for Sphinx doc builds. +docutils # Tooling for RST processing and the swagger extension. +Jinja2 # Requires investiation. Possibly inherited from previous repo with a custom theme. +PyYaml # Requires investigation. Possibly used as tooling for swagger API reference content. diff --git a/docs/docsite/requirements.txt b/docs/docsite/requirements.txt index fd4bc52d97..46bad56c7d 100644 --- a/docs/docsite/requirements.txt +++ b/docs/docsite/requirements.txt @@ -1,5 +1,74 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile --allow-unsafe --output-file=docs/docsite/requirements.txt --strip-extras docs/docsite/requirements.in +# +alabaster==0.7.13 + # via sphinx +ansible-pygments==0.1.1 + # via sphinx-ansible-theme +babel==2.12.1 + # via sphinx +certifi==2023.7.22 + # via requests +charset-normalizer==3.2.0 + # via requests +docutils==0.16 + # via + # -r docs/docsite/requirements.in + # sphinx + # sphinx-rtd-theme +idna==3.4 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.0.3 + # via + # -r docs/docsite/requirements.in + # sphinx +markupsafe==2.1.3 + # via jinja2 +packaging==23.1 + # via sphinx +pygments==2.16.1 + # via + # ansible-pygments + # sphinx +pyyaml==6.0.1 + # via -r docs/docsite/requirements.in +requests==2.31.0 + # via sphinx +snowballstemmer==2.2.0 + # via sphinx sphinx==5.1.1 + # via + # -r docs/docsite/requirements.in + # sphinx-ansible-theme + # sphinx-rtd-theme + # sphinxcontrib-applehelp + # sphinxcontrib-devhelp + # sphinxcontrib-htmlhelp + # sphinxcontrib-jquery + # sphinxcontrib-qthelp + # sphinxcontrib-serializinghtml sphinx-ansible-theme==0.9.1 -docutils==0.16 -Jinja2<3.1 -PyYaml + # via -r docs/docsite/requirements.in +sphinx-rtd-theme==1.3.0 + # via sphinx-ansible-theme +sphinxcontrib-applehelp==1.0.7 + # via sphinx +sphinxcontrib-devhelp==1.0.5 + # via sphinx +sphinxcontrib-htmlhelp==2.0.4 + # via sphinx +sphinxcontrib-jquery==4.1 + # via sphinx-rtd-theme +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.6 + # via sphinx +sphinxcontrib-serializinghtml==1.1.9 + # via sphinx +urllib3==2.0.4 + # via requests @@ -19,8 +19,20 @@ commands = select = F401,F402,F821,F823,F841,F811,E265,E266,F541,W605,E722,F822,F523,W291,F405 exclude = awx/ui/node_modules,awx/ui/node_modules,env,awx_collection_build +[testenv:pip-compile-docs] +description = Compile docs build lockfiles +deps = + # pip-tools config file support was introduced in v7 + pip-tools >= 7 +commands = + {envpython} -m piptools compile \ + --output-file=docs/docsite/requirements.txt \ + docs/docsite/requirements.in + [testenv:docs] description = Build documentation -deps = -r{toxinidir}/docs/docsite/requirements.txt +deps = + -r{toxinidir}/docs/docsite/requirements.in + -c{toxinidir}/docs/docsite/requirements.txt commands = sphinx-build -T -E -W -n --keep-going {tty:--color} -j auto -c docs/docsite -d docs/docsite/build/doctrees -b html docs/docsite/rst docs/docsite/build/html |