Sphinx-Needs-Capri ================== .. image:: /_static/sphinx_needs_capri_logo.png :align: center :width: 50% This `Sphinx `_ extension provides scripts and directives to synchronize data between `codebeamer `_ from `Intland `_ and the Requirement Engineering extension `Sphinx-Needs `_ from `useblocks `_. .. warning:: This project is in an early Alpha phase. So code, tests and docs are just getting created and may not be stable or even complete. Usage ----- Inside a Sphinx project ~~~~~~~~~~~~~~~~~~~~~~~ ``Sphinx-Needs-Capri`` uses the :ref:`services mechanism ` of `Sphinx-Needs `__. .. code-block:: rst .. needservice:: codebeamer :query: project.name IN ('my_project', 'another_project') :prefix: CB_IMPORT_ The query gets executed against the `Issue REST API `_ of codebeamer. For details take a look into :ref:`need_service`. As script cb2needs ~~~~~~~~~~~~~~~~~~ Use the script ``cb2needs`` to get a json file, which can be used via directive :ref:`needsimport ` from the `Sphinx-Needs `__ extension to filter and import needed data into the right place of your Sphinx documentation. **Example**: Inside your project ``/docs`` folder run ``cb2needs --url my_codebeamer.com --user me --password secret -output needs.json``. This will create the file ``/docs/needs.json``. Then inside any rst file add: .. code-block:: rst My open issues from codebeamer: .. needimport:: /needs.json :filter: status == "open" For details please take a look into :ref:`cb2needs` and :ref:`needsimport `. Content ------- .. toctree:: :maxdepth: 2 installation needs_service cb2needs contribute Changelog --------- 0.1.0 ~~~~~ **Released**: under development * Improvement: Example issue... (`#1 `_) License ------- .. literalinclude:: ../LICENSE