This document describes the current stable version of pytest_celery (1.0). For development docs, go here.

Shpinx Documentation

Release:

1.0

Date:

Apr 29, 2024

The plugin uses the sphinx_celery engine to generate the documentation. The documentation is written in reStructuredText format and is located in the docs directory of the repository.

Building the documentation

To build the documentation, use the docs tox environment.

Live Documentation

To serve the documentation locally, use the docs-livehtml tox environment.

Generate API Documentation

To generate the API documentation, use the docs-apidoc tox environment.

Linting the documentation

To lint the documentation, use the lint tox environment, or these Makefile commands:

make -C ./docs apicheck
make -C ./docs linkcheck
make -C ./docs configcheck

Makefile

The docs are managed using the following Makefile:

docs.Makefile

help:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  html       to make standalone HTML files"
	@echo "  livehtml   to start a local server hosting the docs"
	@echo "  dirhtml    to make HTML files named index.html in directories"
	@echo "  singlehtml to make a single large HTML file"
	@echo "  pickle     to make pickle files"
	@echo "  json       to make JSON files"
	@echo "  htmlhelp   to make HTML files and a HTML help project"
	@echo "  qthelp     to make HTML files and a qthelp project"
	@echo "  applehelp  to make an Apple Help Book"
	@echo "  devhelp    to make HTML files and a Devhelp project"
	@echo "  epub       to make an epub"
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  text       to make text files"
	@echo "  man        to make manual pages"
	@echo "  texinfo    to make Texinfo files"
	@echo "  gettext    to make PO message catalogs"
	@echo "  changes    to make an overview of all changed/added/deprecated items"
	@echo "  xml        to make Docutils-native XML files"
	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
	@echo "  linkcheck  to check all external links for integrity"
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
	@echo "  coverage   to run coverage check of the documentation (if enabled)"
	@echo "  apicheck   to verify that all modules are present in autodoc"
	@echo "  configcheck to verify that all modules are present in autodoc"
	@echo "  apidoc     to regenerate API documentation with sphinx-apidoc"