diff options
author | Don Naro <dnaro@redhat.com> | 2023-03-02 18:31:08 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-02 13:31:08 -0500 |
commit | 352010f9c322f5cfd1f61d5e66cd8eb7fa0b49b6 (patch) | |
tree | 5c12469becd9800fdf574e989dd4980fc101ff84 /docs | |
parent | 980ec1642233e48b71882c2018604c2b191933c2 (diff) | |
download | ansible-352010f9c322f5cfd1f61d5e66cd8eb7fa0b49b6.tar.gz |
improve doc dependency install steps (#80120)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/docsite/rst/community/documentation_contributions.rst | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst index 223c4e252a..117d225283 100644 --- a/docs/docsite/rst/community/documentation_contributions.rst +++ b/docs/docsite/rst/community/documentation_contributions.rst @@ -93,19 +93,26 @@ To work with documentation on your local machine, you need to have python-3.9 or .. _Ansible dependencies: https://github.com/ansible/ansible/blob/devel/requirements.txt .. _documentation dependencies: https://github.com/ansible/ansible/blob/devel/docs/docsite/requirements.txt -.. code-block:: bash +Drop the ``--user`` option in the following commands if you use a virtual environment (venv/virtenv). - pip install --user -r requirements.txt - pip install --user -r docs/docsite/requirements.txt +#. Upgrade pip before installing dependencies (recommended). -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 -.. code-block:: bash + pip install --user --upgrade pip + +#. Install Ansible dependencies. + + .. code-block:: bash + + pip install --user -r requirements.txt + +#. Install either the unpinned or tested documentation dependencies. - pip install --user -r requirements.txt - pip install --user -r test/sanity/code-smell/docs-build.requirements.txt + .. code-block:: bash -You can drop ``--user`` if you have set up a virtual environment (venv/virtenv). + pip install --user -r requirements.txt # This file installs unpinned versions that can cause problems with the Ansible docs build. + pip install --user -r test/sanity/code-smell/docs-build.requirements.txt # This file installs tested dependency versions that are used by CI. .. note:: |