The ``documentation.py`` module
===============================
.. py:module:: src.ansys.pre_commit_hooks.quality_rules.documentation
Summary
-------
.. py:currentmodule:: documentation
.. tab-set::
.. tab-item:: Classes
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.Documentation`
- Documentation rule family.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC001`
- The doc/source structure exists.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC002`
- The Sphinx config exists.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC003`
- Numpydoc is enabled for NumPy-style API documentation.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC004`
- Intersphinx is enabled for cross-project documentation references.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC005`
- The index page has a getting started section.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC006`
- The index page has an API reference section.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC007`
- Gallery examples are recommended when a gallery extension is enabled.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC008`
- The Ansys Sphinx theme and PyAnsys branding are configured.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC009`
- Project and page titles are configured.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC010`
- Site author, copyright, and CNAME metadata are configured.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC011`
- The Ansys theme version switcher is configured.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC012`
- The index links required documentation pages with cards.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC013`
- Authored RST filenames use lowercase letters and hyphens.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC014`
- The getting-started page is provided as a root page or section index.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC015`
- The user-guide page is provided as a root page or section index.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC016`
- The API page is provided as a root page or section index.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC017`
- The examples page is provided as a root page or section index.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC018`
- The contribute page is provided as a root page or section index.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC019`
- The changelog root page exists.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC020`
- The getting-started section contains documentation files.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC021`
- The user-guide section contains documentation files.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC022`
- The API section contains documentation files.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC023`
- The examples section contains files.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC024`
- The contribute section contains documentation files.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC025`
- The user contributor guide is recommended.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC026`
- The documentarian contributor guide is recommended.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC027`
- The developer contributor guide is recommended.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC028`
- The interrogate hook checks docstring coverage.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC029`
- Sphinx AutoAPI or an API reference page is available.
* - :py:obj:`~src.ansys.pre_commit_hooks.quality_rules.documentation.DOC030`
- A cheatsheet is added to the documentation.
.. tab-item:: Constants
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~DOCUMENTATION_QUALITY_RULES`
-
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
Documentation
DOC001
DOC002
DOC003
DOC004
DOC005
DOC006
DOC007
DOC008
DOC009
DOC010
DOC011
DOC012
DOC013
DOC014
DOC015
DOC016
DOC017
DOC018
DOC019
DOC020
DOC021
DOC022
DOC023
DOC024
DOC025
DOC026
DOC027
DOC028
DOC029
DOC030
Description
-----------
Documentation structure and Sphinx configuration checks.
The checks cover the documentation source tree and layout, Sphinx configuration,
index card links, authored RST filenames, gallery examples, and API docstring
coverage tooling.
..
!! processed by numpydoc !!
Module detail
-------------
.. py:data:: DOCUMENTATION_QUALITY_RULES
:type: tuple[type[Documentation], ...]