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

Remove html extension from documentation #1981

Merged
merged 1 commit into from
Mar 14, 2022
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
1 change: 1 addition & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,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
5 changes: 2 additions & 3 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ to create a new rule by following the steps below:

* Use a short but clear class name, which must match the filename
* Pick an unused ``id``, the first number is used to determine rule section.
Look at rules_ page and pick one that matches the best your new rule.
see which one fits best.
Look at :ref:`rules <default_rules>` page and pick one that matches the best
your new rule and ee which one fits best.
* Include ``experimental`` tag. Any new rule must stay as
experimental for at least two weeks until this tag is removed in next major
release.
Expand All @@ -47,4 +47,3 @@ 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
2 changes: 2 additions & 0 deletions docs/default_rules.rst
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.. _default_rules:

.. ansible-lint-default-rules-list::