Metadata-Version: 2.4
Name: ansys-scade-almgw-sphinx-needs
Version: 0.3.0
Summary: Ansys SCADE ALM Gateway connector for sphinx-needs.
Keywords: Scade,ALM Gateway,sphinx,needs
Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Requires-Python: >=3.7,!=3.8.*,!=3.9.*,<3.11
Description-Content-Type: text/x-rst
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
License-File: LICENSE
Requires-Dist: importlib-metadata >= 1.0; python_version < '3.8'
Requires-Dist: importlib-metadata >= 4.0; python_version >= '3.8'
Requires-Dist: ansys-scade-pyalmgw
Requires-Dist: build==1.2.2.post1 ; extra == "build"
Requires-Dist: twine==6.1.0 ; extra == "build"
Requires-Dist: ansys-sphinx-theme==1.3.3 ; extra == "doc"
Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
Requires-Dist: nbsphinx==0.9.7 ; extra == "doc"
Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
Requires-Dist: sphinx==8.1.3 ; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints==3.0.1 ; extra == "doc"
Requires-Dist: sphinxcontrib-globalsubs==0.1.2 ; extra == "doc"
Requires-Dist: sphinxcontrib-httpdomain==1.8.1 ; extra == "doc"
Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
Requires-Dist: sphinx-design===0.6.1 ; extra == "doc"
Requires-Dist: sphinx-jinja==2.0.2 ; extra == "doc"
Requires-Dist: pytest >= 8.3.4 ; extra == "tests" and ( python_version >= '3.8')
Requires-Dist: pytest <= 7.4.4 ; extra == "tests" and ( python_version < '3.8')
Requires-Dist: pytest-cov >= 6.0.0 ; extra == "tests" and ( python_version >= '3.8')
Requires-Dist: pytest-cov <= 4.1.0 ; extra == "tests" and ( python_version < '3.8')
Requires-Dist: pyparsing ; extra == "tests"
Project-URL: discussions, https://github.com/ansys/scade-almgw-sphinx-needs/discussions
Project-URL: documentation, https://almgw-sphinx-needs.scade.docs.pyansys.com
Project-URL: homepage, https://www.ansys.com/products/embedded-software/ansys-scade-suite
Project-URL: issues, https://github.com/ansys/scade-almgw-sphinx-needs/issues
Project-URL: releases, https://github.com/ansys/scade-almgw-sphinx-needs/releases
Project-URL: source, https://github.com/ansys/scade-almgw-sphinx-needs
Provides-Extra: build
Provides-Extra: doc
Provides-Extra: tests

Ansys SCADE ALM Gateway connector for sphinx-needs
==================================================
|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |ruff| |doc|

..
   |ansys-scade| image:: https://img.shields.io/badge/Ansys-SCADE-ffb71b?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
   :target: https://github.com/ansys-scade/
   :alt: Ansys SCADE

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
   :target: https://docs.pyansys.com/
   :alt: PyAnsys

.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-scade-almgw-sphinx-needs?logo=pypi
   :target: https://pypi.org/project/ansys-scade-almgw-sphinx-needs/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-scade-almgw-sphinx-needs.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/ansys-scade-almgw-sphinx-needs
   :alt: PyPI

.. |codecov| image:: https://codecov.io/gh/ansys/scade-almgw-sphinx-needs/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/ansys/scade-almgw-sphinx-needs
   :alt: Codecov

.. |GH-CI| image:: https://github.com/ansys/scade-almgw-sphinx-needs/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/scade-almgw-sphinx-needs/actions/workflows/ci_cd.yml

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff
   :alt: Ruff

.. |doc| image:: https://img.shields.io/badge/docs-almgw--sphinx--needs-green.svg?style=flat
   :target: https://almgw-sphinx-needs.scade.docs.pyansys.com
   :alt: Doc


Overview
--------
Ansys SCADE ALM Gateway connector for sphinx-needs allows managing
SCADE traceability with `sphinx-needs`_.

Requirements
------------
The ``ansys-scade-almgw-sphinx-needs`` package supports only the versions of Python delivered with
Ansys SCADE, starting from 2021 R2:

* 2021 R2 through 2023 R1: Python 3.7
* 2023 R2 and later: Python 3.10

Ansys SCADE ALM Gateway connector for sphinx-needs has two installation modes: user and developer. To install for use,
see `Getting started <https://almgw-sphinx-needs.scade.docs.pyansys.com/version/stable/getting-started/index.html>`_.
To install for development, see `Contribute <https://almgw-sphinx-needs.scade.docs.pyansys.com/version/stable/contributing.html>`_.

Documentation and issues
------------------------
Documentation for the latest stable release of Ansys SCADE ALM Gateway connector for sphinx-needs is hosted at
`Ansys SCADE ALM Gateway connector for sphinx-needs documentation <https://almgw-sphinx-needs.scade.docs.pyansys.com/>`_.

In the upper right corner of the documentation's title bar, there is an option for
switching from viewing the documentation for the latest stable release to viewing the
documentation for the development version or previously released versions.

On the `Ansys SCADE ALM Gateway connector for sphinx-needs Issues <https://github.com/ansys/scade-almgw-sphinx-needs/issues>`_
page, you can create issues to report bugs and request new features. On the `Discussions <https://discuss.ansys.com/>`_
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

License
~~~~~~~
Ansys SCADE ALM Gateway connector for sphinx-needs is licensed under the MIT license.

This toolkit makes no commercial claim over Ansys whatsoever. The use of this toolkit
requires a legally licensed copy of the Ansys SCADE Suite. For more information,
see the `Ansys SCADE Suite <https://www.ansys.com/products/embedded-software/ansys-scade-suite>`_
page on the Ansys website.

.. LINKS AND REFERENCES
.. _sphinx-needs: https://www.sphinx-needs.com/

