Skip to content

Commit db592d2

Browse files
authored
Suggest adt install (#124)
* Suggest adt install * Add mkdocs macro for recommended installation * Updated docs build command
1 parent ff28c25 commit db592d2

File tree

5 files changed

+11
-4
lines changed

5 files changed

+11
-4
lines changed

.config/constraints.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ markdown-include==0.8.1
4848
markupsafe==2.1.5
4949
mergedeep==1.3.4
5050
mkdocs==1.5.3
51-
mkdocs-ansible==24.2.1
51+
mkdocs-ansible==24.3.0
5252
mkdocs-autorefs==0.5.0
5353
mkdocs-gen-files==0.5.0
5454
mkdocs-htmlproofer-plugin==1.0.0

.config/requirements-docs.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
mkdocs-ansible>=0.2.0
1+
mkdocs-ansible>=24.3.0

.readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ build:
1111
python: "3.11"
1212
commands:
1313
- pip install --user tox
14-
- python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/
14+
- python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/
1515
python:
1616
install:
1717
- method: pip

docs/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,13 @@ By placing collections into the python site-packages directory they are discover
1818

1919
### Setting up a development environment
2020

21+
{{ install_from_adt("ansible-dev-environment") }}
22+
23+
```bash
24+
pip install ansible-dev-environment --user
25+
```
26+
2127
```
22-
$ pip install ansible-dev-environment --user
2328
$ git clone <collection_repo>
2429
$ cd <collection_repo>
2530
$ ade install -e .\[test] --venv venv

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ nav:
4545

4646
plugins:
4747
- autorefs
48+
- macros:
49+
modules: [mkdocs-ansible:mkdocs_ansible]
4850
- markdown-exec
4951
- material/search:
5052
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

0 commit comments

Comments
 (0)