Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation URLs #69

Merged
merged 1 commit into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ fontawesome
htmlproofer
inlinehilite
linenums
linkchecker
linkcheckerrc
magiclink
minversion
mkdocs
Expand Down
1 change: 1 addition & 0 deletions .config/requirements.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
cairosvg>=2.6.0
linkchecker>=10.3.0
markdown-exec>=1.3.0
markdown-include>=0.8.1
mkdocs-gen-files>=0.4.0
Expand Down
2 changes: 2 additions & 0 deletions .config/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ colorama==0.4.6
csscompressor==0.9.5
cssselect2==0.7.0
defusedxml==0.7.1
dnspython==2.4.2
ghp-import==2.1.0
griffe==0.38.0
htmlmin2==0.1.13
idna==3.4
importlib-metadata==6.8.0
jinja2==3.1.2
jsmin==3.0.1
linkchecker==10.3.0
markdown==3.5.1
markdown-exec==1.7.0
markdown-include==0.8.1
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ dist
site
src/mkdocs_ansible/_version.py
.cache
_readthedocs
_readthedocs
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
python:
install:
- method: pip
Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ look and feel for any project related to [Ansible](https://docs.ansible.com/) ec

Some of the projects that use this theme are:

- [ansible-compat](https://ansible-compat.readthedocs.io/)
- [ansible-devtools](https://ansible-devtools.readthedocs.io/)
- [ansible-language-server](https://ansible-language-server.readthedocs.io/)
- [ansible-lint](https://ansible-lint.readthedocs.io/)
- [ansible-navigator](https://ansible-navigator.readthedocs.io/)
- [molecule](https://molecule.readthedocs.io/)
- [ansible-compat](https://ansible.readthedocs.io/projects/compat/)
- [ansible-devtools](https://ansible.readthedocs.io/projects/dev-tools/)
- [ansible-language-server](https://ansible.readthedocs.io/projects/language-server/)
- [ansible-lint](https://ansible.readthedocs.io/projects/lint/)
- [ansible-navigator](https://ansible.readthedocs.io/projects/navigator/)
- [molecule](https://ansible.readthedocs.io/projects/molecule/)
12 changes: 12 additions & 0 deletions linkcheckerrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# spell-checker:ignore checkextern robotstxt localwebroot ignorewarnings
[filtering]
checkextern=1
ignore=
xml.gz$
404.html
# https://github.com/squidfunk/mkdocs-material/pull/6386
ignorewarnings=http-redirected

[checking]
robotstxt=0
localwebroot=./
12 changes: 11 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
site_name: Ansible MkDocs Theme
site_url: https://mkdocs-ansible.readthedocs.io/
site_url: https://ansible.readthedocs.io/projects/mkdocs-ansible/
site_author: Ansible
site_description: >-
This mkdocs theme is based on mkdocs-material and aims to provide a
Expand Down Expand Up @@ -97,3 +97,13 @@ markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde

validation:
nav:
omitted_files: warn
not_found: warn
absolute_links: warn
links:
not_found: warn
absolute_links: warn
unrecognized_links: warn
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ keywords = ["ansible", "mkdocs", "theme"]

[project.urls]
homepage = "https://github.com/ansible/mkdocs-ansible"
documentation = "https://mkdocs-ansible.readthedocs.io/"
documentation = "https://ansible.readthedocs.io/projects/mkdocs-ansible/"
repository = "https://github.com/ansible/mkdocs-ansible"
changelog = "https://github.com/ansible/mkdocs-ansible/releases"

Expand Down
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ setenv =
skip_install = false
usedevelop = true
commands =
mkdocs build {posargs:}
mkdocs build --strict --strict --site-dir=_readthedocs/html/ {posargs:}
linkchecker -f linkcheckerrc _readthedocs/html/

[testenv:pkg]
description =
Expand Down