created a demo

Author: juiwenchen

pyproject.toml

@@ -76,6 +76,21 @@ codelinks = "sphinx_codelinks.cmd:app"
 "docs:rm" = "rm -rf docs/_build/html"
 "docs" = "sphinx-build -nW --keep-going -b html -T -c docs docs/source docs/_build/html"
 "docs:clean" = { chain = ["docs:rm", "docs"] }
+# needextend demo
+"analyse" = "codelinks analyse tests/data/analyse/default_config.toml"
+"analyse:rm" = "rm -rf output/marked_content.json"
+"bridge" = "codelinks bridge output/marked_content.json --outdir tests/data/needextend_demo"
+"bridge:rm" = "rm -rf tests/data/needextend_demo/needextend.rst"
+"demo:rm" = "rm -rf tests/data/needextend_demo/_build"
+"demo:build" = "sphinx-build -nW --keep-going -b html -T -c tests/data/needextend_demo tests/data/needextend_demo tests/data/needextend_demo/_build/html"
+"demo:clean" = { chain = [
+  "demo:rm",
+  "analyse:rm",
+  "bridge:rm",
+  "analyse",
+  "bridge",
+  "demo:build",
+] }
 
 [tool.ruff.lint]
 extend-select = [

tests/data/needextend_demo/README.md

@@ -0,0 +1,7 @@
+# Needextend Demo
+
+Run the following command in project root to have demo generated
+
+```bash
+rye run demo:clean
+```

tests/data/needextend_demo/conf.py

@@ -0,0 +1,38 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "test_needextend"
+copyright = "2025, useblocks"
+author = "team useblocks"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+# html_static_path = ["_static"]
+
+extensions = ["sphinx_needs", "sphinx_codelinks"]
+
+# for needextend to work with remote url
+needs_extra_options = ["remote_url"]
+
+needs_string_links = {
+    "custom_name": {
+        "regex": r"^(?P<value>.+)#L(?P<lineno>.*)?",
+        "link_url": "{url}",
+        "link_name": "{{value}}#L{{lineno}}",
+        "options": ["remote_url"],
+    }
+}

tests/data/needextend_demo/index.rst

@@ -0,0 +1,13 @@
+.. impl:: title 1
+    :id: NEED_001
+
+.. impl:: title 2
+    :id: NEED_002
+
+.. impl:: title 3
+    :id: NEED_003
+
+.. impl:: title 4
+    :id: NEED_004
+
+.. include:: needextend.rst

tests/data/needextend_demo/needextend.rst

@@ -0,0 +1,14 @@
+.. needextend:: NEED_001
+   :remote_url: https://github.com/useblocks/sphinx-codelinks/blob/1759d19e8694c049c68e7f95ce93d951d1ed0336/tests/data/need_id_refs/dummy_1.cpp#L3
+
+.. needextend:: NEED_002
+   :remote_url: https://github.com/useblocks/sphinx-codelinks/blob/1759d19e8694c049c68e7f95ce93d951d1ed0336/tests/data/need_id_refs/dummy_1.cpp#L3
+
+.. needextend:: NEED_003
+   :remote_url: https://github.com/useblocks/sphinx-codelinks/blob/1759d19e8694c049c68e7f95ce93d951d1ed0336/tests/data/need_id_refs/dummy_1.cpp#L3
+
+.. needextend:: NEED_004
+   :remote_url: https://github.com/useblocks/sphinx-codelinks/blob/1759d19e8694c049c68e7f95ce93d951d1ed0336/tests/data/need_id_refs/dummy_1.cpp#L3
+
+.. needextend:: NEED_003
+   :remote_url: https://github.com/useblocks/sphinx-codelinks/blob/1759d19e8694c049c68e7f95ce93d951d1ed0336/tests/data/need_id_refs/dummy_1.cpp#L8