melexis / sphinx-traceability-extension

Traceability extension for Sphinx documentation generator
GNU General Public License v3.0
25 stars 9 forks source link
sphinx-extension

GPL3 License PyPI packaged release Build status Documentation Code Coverage Code Climate Status Contributions welcome

Sphinx Traceability plugin

Sphinx plugin that allows defining documentation items and relations between those items. Can be used as a requirements management tool for e.g. ISO26262 projects.

Contents

Process

The Melexis.SWCC (SoftWare Competence Center) process has a Guideline for documenting in reStructuredText (RST). It holds guidelines for using the traceability plugin with naming conventions, templates, etc.