.. _dox_util:

dox_util
========

Collection of small convenience features for Sphinx documentations.

.. list-table::
    :widths: 30 70
    :header-rows: 1
    :width: 100%

    * - Name
      - Description
    * - :doc:`pages/user/extlinks`
      - Makes links to external websites more convenient.
    * - :doc:`pages/user/linkcheck`
      - Optimizes built-in linkcheck behaviour of Sphinx.
    * - :doc:`pages/user/rule`
      - Referenceable rules role.
    * - :doc:`pages/user/source`
      - Several ways to link to source code.
    * - :doc:`pages/user/toctree`
      - Tolerant toctree which ignores missing files and other useful directives.
    * - :doc:`pages/user/todo`
      - Light-weight todo role.
    * - :doc:`pages/user/weak`
      - Weak references which do not warn if labels do not exist.

.. toctree::
   :maxdepth: 1
   :caption: User Documentation
   :hidden:

   pages/user/extlinks
   pages/user/linkcheck
   pages/user/rule
   pages/user/source
   pages/user/toctree
   pages/user/todo
   pages/user/weak

.. toctree::
   :maxdepth: 1
   :caption: Appendix
   :hidden:

   pages/appendix/changelog