Skip to content
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

Jump to bottom

trim down to use sanity test docs requirements file #77612

Merged
merged 6 commits into from
Apr 27, 2022
Merged

trim down to use sanity test docs requirements file #77612

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c105ee
trim down to use sanity test docs requirements file
samccann Apr 22, 2022
31f2b6c
add requrements back
samccann Apr 22, 2022
b1daa3b
add back missing sentence
samccann Apr 22, 2022
7ebdba6
fix codeblock
samccann Apr 22, 2022
5a1545e
Update docs/docsite/rst/community/documentation_contributions.rst
samccann Apr 25, 2022
f383629
Update docs/docsite/rst/community/documentation_contributions.rst
samccann Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 0 additions & 19 deletions docs/docsite/known_good_reqs.txt
View file
Open in desktop

This file was deleted.

9 changes: 5 additions & 4 deletions docs/docsite/rst/community/documentation_contributions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Setting up your environment to build documentation locally

To build documentation locally, ensure you have a working :ref:`development environment <environment_setup>`.

To work with documentation on your local machine, you need to have python-3.5 or greater and install the `Ansible dependencies`_ and `documentation dependencies`_, which are listed in two :file:`requirements.txt` files to make installation easier:
To work with documentation on your local machine, you need to have python-3.9 or greater and install the `Ansible dependencies`_ and `documentation dependencies`_, which are listed in two files to make installation easier:

.. _Ansible dependencies: https://github.com/ansible/ansible/blob/devel/requirements.txt
.. _documentation dependencies: https://github.com/ansible/ansible/blob/devel/docs/docsite/requirements.txt
Expand All @@ -84,12 +84,13 @@ To work with documentation on your local machine, you need to have python-3.5 or
pip install --user -r requirements.txt
pip install --user -r docs/docsite/requirements.txt

The :file:`docs/docsite/requirements.txt` file allows a wide range of versions and may install new releases of required packages. New releases of these packages may cause problems with the Ansible docs build. If you want to install tested versions of these dependencies, use :file:`docs/docsite/known_good_reqs.txt` instead:
The :file:`docs/docsite/requirements.txt` file allows a wide range of versions and may install new releases of required packages. New releases of these packages may cause problems with the Ansible docs build. If you want to install tested versions of these dependencies, use :file:`test/sanity/code-smell/docs-build.requirements.txt` instead, which matches the dependencies used by CI:

.. code-block:: bash
samccann marked this conversation as resolved.
Show resolved Hide resolved

pip install --user -r requirements.txt
pip install --user -r docs/docsite/known_good_reqs.txt
pip install --user -r test/sanity/code-smell/docs-build.requirements.txt



You can drop ``--user`` if you have set up a virtual environment (venv/virtenv).

Expand Down