updated docs

Author: juiwenchen

docs/source/components/write.rst

@@ -0,0 +1,49 @@
+.. _write:
+
+Write
+=====
+
+The ``write`` command is used to generate reStructuredText files from the markers extracted by the ``analyse`` command.
+This allows you to create documentation that includes links to source code based on the need ids specified in your code comments.
+
+Example usage
+-------------
+
+With the following extracted markers fron the ``analyse`` command,
+
+.. code-block:: json
+
+   {
+       "my_project": [
+           {
+               "filepath": "/home/demo/git_repo/ub/sphinx-codelinks/tests/data/need_id_refs/dummy_1.cpp",
+               "remote_url": "https://github.com/useblocks/sphinx-codelinks/blob/main/tests/data/need_id_refs/dummy_1.cpp#L3",
+               "source_map": {
+                   "start": {"row": 2, "column": 13},
+                   "end": {"row": 2, "column": 51}
+               },
+               "tagged_scope": "void dummy_func1(){\n     //...\n }",
+               "need_ids": ["NEED_001", "NEED_002", "NEED_003", "NEED_004"],
+               "marker": "@need-ids:",
+               "type": "need-id-refs"
+           },
+       ],
+   }
+
+The following RST file with :external+needs:ref:`needextend <needextend>` directive can be generated by the ``write rst`` command:
+
+.. code-block:: rst
+
+    .. needextend:: NEED_001
+           :remote-url: https://github.com/useblocks/sphinx-codelinks/blob/main/tests/data/need_id_refs/dummy_1.cpp#L3
+
+    .. needextend:: NEED_002
+           :remote-url: https://github.com/useblocks/sphinx-codelinks/blob/main/tests/data/need_id_refs/dummy_1.cpp#L3
+
+    .. needextend:: NEED_003
+           :remote-url: https://github.com/useblocks/sphinx-codelinks/blob/main/tests/data/need_id_refs/dummy_1.cpp#L3
+
+    .. needextend:: NEED_004
+           :remote-url: https://github.com/useblocks/sphinx-codelinks/blob/main/tests/data/need_id_refs/dummy_1.cpp#L3
+
+More examples can be found in `test cases <https://github.com/useblocks/sphinx-codelinks/blob/main/tests/test_needextend_write.py>`__

docs/source/development/change_log.rst

@@ -8,7 +8,7 @@ Changelog
 1.0.0
 -----
 
-:Released: 12.08.2025
+:Released: 22.08.2025
 
 New and Improved
 ................
@@ -24,6 +24,11 @@ New and Improved
 
   The extracted markers and their metadata are saved to a JSON file for further processing.
 
+- ✨ Added a new ``write rst`` CLI command.
+
+  The ``write rst`` command write a reStructuredText file with :external+needs:ref:`needextend <needextend>` directive from the extracted markers generated by ``analyse``.
+  The generated RST can be included in the Sphinx documentation to create the source code links in the existing needs
+
 - 🔨 Replaced ``virtual_docs`` with the new ``analyse`` module.
 
   The ``virtual_docs`` feature, which handled one-line need definitions (:ref:`OneLineCommentStyle <oneline>`),
@@ -33,7 +38,12 @@ New and Improved
 - 🔨 Updated the ``src-trace`` Sphinx directive.
 
   The ``src-trace`` directive now uses the new ``analyse`` API instead of the old ``virtual_docs`` one.
-  Note that the configuration files for ``src-trace`` and the ``analyse`` CLI are not yet compatible; this will be addressed in a future release.
+
+- 🔨 Unified configuration in TOML
+
+  The configuration for ``src-trace`` directive defined in TOML is now compatible with the new ``analyse`` module.
+
+
 
 .. _`release:0.1.2`:
 

docs/source/development/roadmap.rst

@@ -25,7 +25,6 @@ Source Code Parsing
 
   - Rust
   - YAML
-  - SyML
 
 - Enhance ``.gitignore`` handling to support nested ``.gitignore`` files.
 

docs/source/index.rst

@@ -65,6 +65,7 @@ Contents
    components/oneline
    components/analyse
    components/discover
+   components/write
 
 .. toctree::
    :maxdepth: 1