Skip to content

Commit

Permalink
Minor documentation fixes
Browse files Browse the repository at this point in the history
- advertise ansible-dev-tools as an installation alternative
- fixed some broken or redirected URLs
- fixed some typos

Related: [AAP-19818](https://issues.redhat.com/browse/AAP-19818)
  • Loading branch information
ssbarnea authored and shanemcd committed Mar 29, 2024
1 parent 8ce4921 commit 8de2122
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ It does the following:

Note: The API (library) part of this package is not officially supported and
might change as time goes on. CLI commands should be considered stable within
major verions (the `X` of version `X.Y.Z`).
major versions (the `X` of version `X.Y.Z`).

Documentation can be found on [ansible-sign.readthedocs.io](https://ansible-sign.readthedocs.io/en/latest/)
Documentation can be found on [ansible-sign.readthedocs.io](https://ansible.readthedocs.io/projects/sign/en/latest/)
including a
[rundown/tutorial](https://ansible.github.io/ansible-sign/rundown.html)
[rundown/tutorial](https://ansible.readthedocs.io/projects/sign/en/latest/rundown.html)
explaining how to use the CLI for basic project signing and verification.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
html_theme_options = {
"display_version": False,
"titles_only": False,
"documentation_home_url": "https://ansible.github.io/ansible-sign/",
"documentation_home_url": "https://ansible.readthedocs.io/projects/sign/en/latest/",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand Down
11 changes: 11 additions & 0 deletions docs/rundown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,17 @@ Run the following command to install ``ansible-sign``:
$ pip install ansible-sign
.. note::

An **alternative** approach to install ``ansible-sign`` is using the ``ansible-dev-tools`` package.
`Ansible Development Tools (ADT) <https://ansible.readthedocs.io/projects/dev-tools/>`_ is a single Python package that includes all necessary tools to
set up a development environment, generate new collections, build and test the content consistently, resulting in robust automation.

.. code-block:: shell
# This also installs ansible-core if it is not already installed
$ pip3 install ansible-dev-tools
Once it’s installed, run:

.. code-block:: shell
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tox]
minversion = 3.24
envlist = py3,lint
envlist = py3,lint,docs
isolated_build = True


Expand Down

0 comments on commit 8de2122

Please sign in to comment.