Skip to main content

Sphinx extension that adds traceability within documentation

Project description

sphinxcontrib-traceables
==============================================================================

|pypi-version| |pypi-downloads| |docs-status| |build-status|
|coverage-status| |pypi-license|

A Sphinx extension offering traceability within documentation.

This extension provides functionality to define traceable items and
relationships between them in documentation generated by `Sphinx`_.
It also offers visualization of the traceables in various forms, such
as relationship graphs.

More information is available here:

- Documentation: https://sphinxcontrib-traceables.readthedocs.org/en/latest/
- Download: https://pypi.python.org/pypi/sphinxcontrib-traceables
- Development: https://github.com/t4ngo/sphinxcontrib-traceables

.. _Sphinx: http://sphinx-doc.org/

.. |docs-status| image:: https://readthedocs.org/projects/sphinxcontrib-traceables/badge/?version=latest
:alt: Documentation status
:scale: 100%
:target: https://sphinxcontrib-traceables.readthedocs.org/en/latest/?badge=latest

.. |build-status| image:: https://travis-ci.org/t4ngo/sphinxcontrib-traceables.svg
:alt: Build status
:target: https://travis-ci.org/t4ngo/sphinxcontrib-traceables

.. |coverage-status| image:: https://coveralls.io/repos/t4ngo/sphinxcontrib-traceables/badge.svg?branch=master&service=github
:alt: Test coverage status
:target: https://coveralls.io/github/t4ngo/sphinxcontrib-traceables?branch=master

.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-traceables.svg
:alt: Latest version at PyPI
:target: https://pypi.python.org/pypi/sphinxcontrib-traceables

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinxcontrib-traceables.svg
:alt: Downloads from PyPI last month
:target: https://pypi.python.org/pypi/sphinxcontrib-traceables

.. |pypi-license| image:: https://img.shields.io/pypi/l/sphinxcontrib-traceables.svg
:alt: License specified at PyPI
:target: https://pypi.python.org/pypi/sphinxcontrib-traceables

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-traceables-0.1.4.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinxcontrib_traceables-0.1.4-py2-none-any.whl (18.1 kB view details)

Uploaded Python 2

File details

Details for the file sphinxcontrib-traceables-0.1.4.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-traceables-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9b17586fa1a6bf1ca44de82b3bd3cdaee9a90b6ad0c4b8abded338766cc86fb1
MD5 50a2b59fe6107c206b969ce68dc495b5
BLAKE2b-256 b76073fbe7fea243c5fea8df6a5f471459d1785cf720cce84d7e733590f687f1

See more details on using hashes here.

File details

Details for the file sphinxcontrib_traceables-0.1.4-py2-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_traceables-0.1.4-py2-none-any.whl
Algorithm Hash digest
SHA256 22dc5adc8d3aad1abeb02cf499f77aaceb0057f638d738b57cd7cf5642a42569
MD5 a1e0758df529b3b4b0e78ae1c34e79fc
BLAKE2b-256 64a93669b09c21cc47bc79b21bf267f2d36334f7b96d7e2aaea15c018cd683f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page