diff --git a/.config/constraints.txt b/.config/constraints.txt index 92faff2..8dcda57 100644 --- a/.config/constraints.txt +++ b/.config/constraints.txt @@ -48,7 +48,7 @@ markdown-include==0.8.1 markupsafe==2.1.5 mergedeep==1.3.4 mkdocs==1.5.3 -mkdocs-ansible==24.2.1 +mkdocs-ansible==24.3.0 mkdocs-autorefs==0.5.0 mkdocs-gen-files==0.5.0 mkdocs-htmlproofer-plugin==1.0.0 diff --git a/.config/requirements-docs.in b/.config/requirements-docs.in index 57e1a15..e91456e 100644 --- a/.config/requirements-docs.in +++ b/.config/requirements-docs.in @@ -1 +1 @@ -mkdocs-ansible>=0.2.0 +mkdocs-ansible>=24.3.0 diff --git a/.readthedocs.yml b/.readthedocs.yml index 78a84d9..1900973 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -11,7 +11,7 @@ build: python: "3.11" commands: - pip install --user tox - - python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/ + - python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/ python: install: - method: pip diff --git a/docs/index.md b/docs/index.md index 62d9a5c..46b882c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,8 +18,13 @@ By placing collections into the python site-packages directory they are discover ### Setting up a development environment +{{ install_from_adt("ansible-dev-environment") }} + +```bash +pip install ansible-dev-environment --user +``` + ``` -$ pip install ansible-dev-environment --user $ git clone $ cd $ ade install -e .\[test] --venv venv diff --git a/mkdocs.yml b/mkdocs.yml index 47577e2..16032cb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,6 +45,8 @@ nav: plugins: - autorefs + - macros: + modules: [mkdocs-ansible:mkdocs_ansible] - markdown-exec - material/search: separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'