Metadata-Version: 2.1
Name: dox_util
Version: 0.1.0
Summary: Collection of small convenience features for Sphinx documentations.
Author: Accenture
License: Apache-2.0
Project-URL: Homepage, https://github.com/esrlabs/dox
Project-URL: Issues, https://github.com/esrlabs/dox/issues
Project-URL: Documentation, https://esrlabs.github.io/dox/dox_util
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Overview

dox_util is a collection of small convenience-features for Sphinx documentations:

- Makes links to external websites more convenient.
- Optimizes built-in linkcheck behaviour of Sphinx.
- Referenceable rules role.
- Several ways to link to source code.
- Tolerant toctree which ignores missing files and other useful directives.
- Light-weight todo role.
- Weak references which do not warn if labels do not exist.
