We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 831c5f0 commit 913d587Copy full SHA for 913d587
1 file changed
docs/source/index.rst
@@ -12,9 +12,11 @@
12
13
.. div:: sd-fs-5 sd-font-italic
14
15
- ``Sphinx-CodeLinks`` is designed for Engineering-as-Code workflows to facilitate Application Lifecycle Management (ALM).
16
- It enables users to define ``Sphinx-Needs`` need items within source code using a single line and automatically extract them
17
- into the documentation during the Sphinx build process.
+ ``Sphinx-CodeLinks`` is a lightweight solution for enabling traceability between source code and documentation.
+ With a single line in your code, you can:
+
18
+ 1. Defining new ``Sphinx-Needs`` - extracted and integrated into the Sphinx build
19
+ 2. Embedding existing need IDs - extracted for cross-referencing with need items in the documentation
20
21
.. grid:: 1 1 2 2
22
:gutter: 2 2 3 3
0 commit comments