mlx.traceability


Namemlx.traceability JSON
Version 11.6.0 PyPI version JSON
download
home_pagehttps://github.com/melexis/sphinx-traceability-extension
SummarySphinx traceability extension (Melexis fork)
upload_time2024-09-12 09:25:53
maintainerNone
docs_urlNone
authorMelexis
requires_python>=3.8
licenseGNU General Public License v3 (GPLv3)
keywords traceability requirements engineering requirements management software engineering systems engineering sphinx requirements aspice iso26262 asil
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![GPL3 License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![PyPI packaged release](https://badge.fury.io/py/mlx.traceability.svg)](https://badge.fury.io/py/mlx.traceability)
[![Build status](https://github.com/melexis/sphinx-traceability-extension/actions/workflows/python-package.yml/badge.svg?branch=master)](https://github.com/melexis/sphinx-traceability-extension/actions/workflows/python-package.yml)
[![Documentation](https://img.shields.io/badge/Documentation-published-brightgreen.svg)](https://melexis.github.io/sphinx-traceability-extension/)
[![Code Coverage](https://codecov.io/gh/melexis/sphinx-traceability-extension/coverage.svg)](https://codecov.io/gh/melexis/sphinx-traceability-extension)
[![Code Climate Status](https://codeclimate.com/github/melexis/sphinx-traceability-extension/badges/gpa.svg)](https://codeclimate.com/github/melexis/sphinx-traceability-extension)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/melexis/sphinx-traceability-extension/issues)


# 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

- [Goal](https://melexis.github.io/sphinx-traceability-extension/goal.html)
- [Installation](https://melexis.github.io/sphinx-traceability-extension/installation.html)
- [Configuration](https://melexis.github.io/sphinx-traceability-extension/configuration.html)
- [Usage](https://melexis.github.io/sphinx-traceability-extension/usage.html)
- [Contributing](https://melexis.github.io/sphinx-traceability-extension/contributing.html)

### 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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/melexis/sphinx-traceability-extension",
    "name": "mlx.traceability",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "traceability, requirements engineering, requirements management, software engineering, systems engineering, sphinx, requirements, ASPICE, ISO26262, ASIL",
    "author": "Melexis",
    "author_email": "jce@melexis.com",
    "download_url": "https://files.pythonhosted.org/packages/b6/c4/2cf83d4790ae65dafd19f95d7453e69e898f5975af042d8da072eaa2cfb4/mlx_traceability-11.6.0.tar.gz",
    "platform": "any",
    "description": "[![GPL3 License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![PyPI packaged release](https://badge.fury.io/py/mlx.traceability.svg)](https://badge.fury.io/py/mlx.traceability)\n[![Build status](https://github.com/melexis/sphinx-traceability-extension/actions/workflows/python-package.yml/badge.svg?branch=master)](https://github.com/melexis/sphinx-traceability-extension/actions/workflows/python-package.yml)\n[![Documentation](https://img.shields.io/badge/Documentation-published-brightgreen.svg)](https://melexis.github.io/sphinx-traceability-extension/)\n[![Code Coverage](https://codecov.io/gh/melexis/sphinx-traceability-extension/coverage.svg)](https://codecov.io/gh/melexis/sphinx-traceability-extension)\n[![Code Climate Status](https://codeclimate.com/github/melexis/sphinx-traceability-extension/badges/gpa.svg)](https://codeclimate.com/github/melexis/sphinx-traceability-extension)\n[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/melexis/sphinx-traceability-extension/issues)\n\n\n# Sphinx Traceability plugin\n\nSphinx plugin that allows defining documentation items and relations between those items. Can be used\nas a requirements management tool for e.g. ISO26262 projects.\n\n## Contents\n\n- [Goal](https://melexis.github.io/sphinx-traceability-extension/goal.html)\n- [Installation](https://melexis.github.io/sphinx-traceability-extension/installation.html)\n- [Configuration](https://melexis.github.io/sphinx-traceability-extension/configuration.html)\n- [Usage](https://melexis.github.io/sphinx-traceability-extension/usage.html)\n- [Contributing](https://melexis.github.io/sphinx-traceability-extension/contributing.html)\n\n### Process\n\nThe Melexis.SWCC (SoftWare Competence Center) process has a Guideline for documenting in reStructuredText (RST).\nIt holds guidelines for using the traceability plugin with naming conventions, templates, etc.\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3 (GPLv3)",
    "summary": "Sphinx traceability extension (Melexis fork)",
    "version": "11.6.0",
    "project_urls": {
        "Documentation": "https://melexis.github.io/sphinx-traceability-extension",
        "Homepage": "https://github.com/melexis/sphinx-traceability-extension",
        "Source": "https://github.com/melexis/sphinx-traceability-extension",
        "Tracker": "https://github.com/melexis/sphinx-traceability-extension/issues"
    },
    "split_keywords": [
        "traceability",
        " requirements engineering",
        " requirements management",
        " software engineering",
        " systems engineering",
        " sphinx",
        " requirements",
        " aspice",
        " iso26262",
        " asil"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0706fdd310ede4dae490016b90351117dac0f258206e128531a65d450b774542",
                "md5": "22a6c065751064ef25f75f8db9591590",
                "sha256": "000c5cd3ef60bd2c70d5f5e83c711352d34b5cd6aba4919d000f5755b090bac3"
            },
            "downloads": -1,
            "filename": "mlx.traceability-11.6.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "22a6c065751064ef25f75f8db9591590",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 77339,
            "upload_time": "2024-09-12T09:25:51",
            "upload_time_iso_8601": "2024-09-12T09:25:51.245559Z",
            "url": "https://files.pythonhosted.org/packages/07/06/fdd310ede4dae490016b90351117dac0f258206e128531a65d450b774542/mlx.traceability-11.6.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b6c42cf83d4790ae65dafd19f95d7453e69e898f5975af042d8da072eaa2cfb4",
                "md5": "4fbe27bf45fbae67e4c7b4c1f38fb111",
                "sha256": "5eef9bb532b0a13e8fa24ecdeb23de8cc35d35be7017bb92d4a5f44ede996460"
            },
            "downloads": -1,
            "filename": "mlx_traceability-11.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4fbe27bf45fbae67e4c7b4c1f38fb111",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 66740,
            "upload_time": "2024-09-12T09:25:53",
            "upload_time_iso_8601": "2024-09-12T09:25:53.056100Z",
            "url": "https://files.pythonhosted.org/packages/b6/c4/2cf83d4790ae65dafd19f95d7453e69e898f5975af042d8da072eaa2cfb4/mlx_traceability-11.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-12 09:25:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "melexis",
    "github_project": "sphinx-traceability-extension",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "mlx.traceability"
}
        
Elapsed time: 0.72648s