**************************************************************************
Examples
**************************************************************************

Documenation examples
=====================

See the ``examples`` directory (available `on GitHub <github-example_>`_)
within this extension's source code for a complete Sphinx project
demonstrating various features provided by this extension.

The documentation obtained from these examples is also directly available here:

  - :doc:`constellation example <constellations:index>`
  - :doc:`requirements example <requirements:index>`


Tests examples
==============

Most functionalities of this extension are tested with pytest. The data for
the tests are in the ``tests/data`` directory (available
`on GitHub <github-test-data_>`_) within this extension's source code.

The documentation obtained from the tests not expecting to raise warnings or
errors are also directly available here:

  - :doc:`Graph test <test-graph:index>`
  - :doc:`List test <test-list:index>`
  - :doc:`matrix test <test-matrix:index>`


.. _github-example:
   https://github.com/superzerg/sphinxcontrib-traceables/tree/master/examples
.. _github-test-data:
   https://github.com/superzerg/sphinxcontrib-traceables/tree/master/tests/data