The documentation.py module#

Summary#

Documentation

Documentation rule family.

DOC001

The doc/source structure exists.

DOC002

The Sphinx config exists.

DOC003

Numpydoc is enabled for NumPy-style API documentation.

DOC004

Intersphinx is enabled for cross-project documentation references.

DOC005

The index page has a getting started section.

DOC006

The index page has an API reference section.

DOC007

Gallery examples are recommended when a gallery extension is enabled.

DOC008

The Ansys Sphinx theme and PyAnsys branding are configured.

DOC009

Project and page titles are configured.

DOC010

Site author, copyright, and CNAME metadata are configured.

DOC011

The Ansys theme version switcher is configured.

DOC012

The index links required documentation pages with cards.

DOC013

Authored RST filenames use lowercase letters and hyphens.

DOC014

The getting-started page is provided as a root page or section index.

DOC015

The user-guide page is provided as a root page or section index.

DOC016

The API page is provided as a root page or section index.

DOC017

The examples page is provided as a root page or section index.

DOC018

The contribute page is provided as a root page or section index.

DOC019

The changelog root page exists.

DOC020

The getting-started section contains documentation files.

DOC021

The user-guide section contains documentation files.

DOC022

The API section contains documentation files.

DOC023

The examples section contains files.

DOC024

The contribute section contains documentation files.

DOC025

The user contributor guide is recommended.

DOC026

The documentarian contributor guide is recommended.

DOC027

The developer contributor guide is recommended.

DOC028

The interrogate hook checks docstring coverage.

DOC029

Sphinx AutoAPI or an API reference page is available.

DOC030

A cheatsheet is added to the documentation.

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.

Module detail#

documentation.DOCUMENTATION_QUALITY_RULES: tuple[type[Documentation], ...]#