Skip to content

Commit f54f775

Browse files
authored
Merge pull request #49 from ssbarnea/chore/docs
Minor documentation fixes
2 parents 8ce4921 + 8de2122 commit f54f775

File tree

4 files changed

+16
-5
lines changed

4 files changed

+16
-5
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ It does the following:
1111

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

16-
Documentation can be found on [ansible-sign.readthedocs.io](https://ansible-sign.readthedocs.io/en/latest/)
16+
Documentation can be found on [ansible-sign.readthedocs.io](https://ansible.readthedocs.io/projects/sign/en/latest/)
1717
including a
18-
[rundown/tutorial](https://ansible.github.io/ansible-sign/rundown.html)
18+
[rundown/tutorial](https://ansible.readthedocs.io/projects/sign/en/latest/rundown.html)
1919
explaining how to use the CLI for basic project signing and verification.

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164
html_theme_options = {
165165
"display_version": False,
166166
"titles_only": False,
167-
"documentation_home_url": "https://ansible.github.io/ansible-sign/",
167+
"documentation_home_url": "https://ansible.readthedocs.io/projects/sign/en/latest/",
168168
}
169169

170170
# Add any paths that contain custom themes here, relative to this directory.

docs/rundown.rst

+11
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ Run the following command to install ``ansible-sign``:
7070
7171
$ pip install ansible-sign
7272
73+
.. note::
74+
75+
An **alternative** approach to install ``ansible-sign`` is using the ``ansible-dev-tools`` package.
76+
`Ansible Development Tools (ADT) <https://ansible.readthedocs.io/projects/dev-tools/>`_ is a single Python package that includes all necessary tools to
77+
set up a development environment, generate new collections, build and test the content consistently, resulting in robust automation.
78+
79+
.. code-block:: shell
80+
81+
# This also installs ansible-core if it is not already installed
82+
$ pip3 install ansible-dev-tools
83+
7384
Once it’s installed, run:
7485

7586
.. code-block:: shell

tox.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tox]
22
minversion = 3.24
3-
envlist = py3,lint
3+
envlist = py3,lint,docs
44
isolated_build = True
55

66

0 commit comments

Comments
 (0)