Skip to content

Commit

Permalink
Remove html extension from documentation
Browse files Browse the repository at this point in the history
Makes URLs nicer by using dirhtml build instead of html. The effect
is that you will no longer see .html as part of URLs.
  • Loading branch information
ssbarnea committed Mar 12, 2022
1 parent 822477b commit 04c83eb
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 6 deletions.
1 change: 1 addition & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ delenv
denormalize
deps
devel
dirhtml
dists
distutils
docstrings
Expand Down
3 changes: 2 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
# keep dirhtml for nice URLs without .html extension
builder: dirhtml
configuration: docs/conf.py
fail_on_warning: true

Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:alt: PyPI version

.. image:: https://img.shields.io/badge/Ansible--lint-rules%20table-blue.svg
:target: https://ansible-lint.readthedocs.io/en/latest/default_rules.html
:target: https://ansible-lint.readthedocs.io/en/latest/default_rules
:alt: Ansible-lint rules explanation

.. image:: https://img.shields.io/badge/Code%20of%20Conduct-black.svg
Expand Down Expand Up @@ -57,7 +57,7 @@ Authors
ansible-lint was created by `Will Thames`_ and is now maintained as part of the
`Ansible`_ by `Red Hat`_ project.

.. _Contribution guidelines: https://ansible-lint.readthedocs.io/en/latest/contributing.html
.. _Contribution guidelines: https://ansible-lint.readthedocs.io/en/latest/contributing
.. _Will Thames: https://github.com/willthames
.. _Ansible: https://ansible.com
.. _Red Hat: https://redhat.com
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ to create a new rule by following the steps below:
displayed correctly in them.

.. _MetaTagValidRule: https://github.com/ansible-community/ansible-lint/blob/main/src/ansiblelint/rules/meta_no_tags.py
.. _rules: https://ansible-lint.readthedocs.io/en/latest/default_rules.html
.. _rules: https://ansible-lint.readthedocs.io/en/latest/default_rules
5 changes: 3 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,11 @@ commands =
. \
"{envdir}/html"

# Build the html docs with Sphinx:
# Build the html docs with Sphinx. Keep `dirhtml` as we do not want .html
# extensions on URLs.
{envpython} -m sphinx \
-j auto \
-b html \
-b dirhtml \
--color \
-a \
-n \
Expand Down

0 comments on commit 04c83eb

Please sign in to comment.