🔧 Run new ubc action on docs

.github/workflows/ci.yaml

@@ -16,6 +16,19 @@ jobs:
           python-version: '3.10'
       - uses: pre-commit/[email protected]
 
+  ubc:
+    name: ubc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: useblocks/ubc-action@main
+        with:
+          version: 0.19.1
+      - name: Run 'ubc check docs'
+        run: ubc check docs
+      - name: Run 'ubc build index docs'
+        run: ubc build index docs --show-warnings
+
   tests-core:
     name: "Core py${{ matrix.python-version }} sphinx~=${{ matrix.sphinx-version }} ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}

docs/_static/tutorial_needs.json

@@ -0,0 +1 @@
+{"current_version": "6.0.1", "project": "Sphinx-Needs", "versions": {"6.0.1": {"creator": {"program": "sphinx_needs", "version": "6.0.1"}, "needs": {"T_001": {"constraints_passed": null, "constraints_results": null, "content": "Test case 1", "external_css": "external_link", "id": "T_001", "title": "Unit test 1", "type": "tutorial-test", "type_name": "Test Case"}, "T_002": {"constraints_passed": null, "constraints_results": null, "content": "Test case 2", "external_css": "external_link", "id": "T_002", "title": "Unit test 2", "type": "tutorial-test", "type_name": "Test Case"}, "T_003": {"constraints_passed": null, "constraints_results": null, "content": "Test case 3", "external_css": "external_link", "id": "T_003", "title": "Unit test 3", "type": "tutorial-test", "type_name": "Test Case"}, "T_004": {"constraints_passed": null, "constraints_results": null, "content": "Test case 4", "external_css": "external_link", "id": "T_004", "title": "Unit test 4", "type": "tutorial-test", "type_name": "Test Case"}}, "needs_amount": 4, "needs_defaults_removed": true, "needs_schema": {"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"amount": {"default": null, "description": "Amount value", "field_type": "extra", "type": "number"}, "another_option": {"default": "", "description": "Another custom option", "field_type": "extra", "type": "string"}, "arch": {"additionalProperties": {"type": "string"}, "default": {}, "description": "Mapping of uml key to uml content.", "field_type": "core", "type": "object"}, "author": {"default": "", "description": "Author of the need", "field_type": "extra", "type": "string"}, "avatar": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "blocks": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "blocks_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "checks": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "checks_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "closed_at": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "comment": {"default": "", "description": "Additional comments", "field_type": "extra", "type": "string"}, "completion": {"default": null, "description": "Completion in %", "field_type": "extra", "type": "integer"}, "config": {"default": "", "description": "Configuration option", "field_type": "extra", "type": "string"}, "constraints": {"default": [], "description": "List of constraint names, which are defined for this need.", "field_type": "core", "items": {"type": "string"}, "type": "array"}, "constraints_error": {"default": null, "description": "An error message set if any constraint failed, and `error_message` field is set in config.", "field_type": "core", "type": ["string", "null"]}, "constraints_passed": {"default": true, "description": "True if all constraints passed, False if any failed, None if not yet checked.", "field_type": "core", "type": ["boolean", "null"]}, "constraints_results": {"additionalProperties": {"type": "object"}, "default": {}, "description": "Mapping of constraint name, to check name, to result, None if not yet checked.", "field_type": "core", "type": ["object", "null"]}, "content": {"default": "", "description": "The main content of the need.", "field_type": "core", "type": "string"}, "created_at": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "docname": {"default": null, "description": "Name of the document where the need is defined (None if external).", "field_type": "core", "type": ["string", "null"]}, "doctype": {"default": ".rst", "description": "The markup type of the content, denoted by the suffix of the source file, e.g. '.rst'.", "field_type": "core", "type": "string"}, "duration": {"default": null, "description": "Time in days", "field_type": "extra", "type": "integer"}, "ends_with": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "ends_with_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "external_css": {"default": "", "description": "CSS class name, added to the external reference.", "field_type": "core", "type": "string"}, "external_url": {"default": null, "description": "URL of the need, if it is an external need.", "field_type": "core", "type": ["string", "null"]}, "github": {"default": "", "description": "GitHub reference", "field_type": "extra", "type": "string"}, "has_dead_links": {"default": false, "description": "True if any links reference need ids that are not found in the need list.", "field_type": "core", "type": "boolean"}, "has_forbidden_dead_links": {"default": false, "description": "True if any links reference need ids that are not found in the need list, and the link type does not allow dead links.", "field_type": "core", "type": "boolean"}, "hours": {"default": null, "description": "Time in hours", "field_type": "extra", "type": "integer"}, "id": {"description": "ID of the data.", "field_type": "core", "type": "string"}, "id_prefix": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "image": {"default": "", "description": "Image reference", "field_type": "extra", "type": "string"}, "is_external": {"default": false, "description": "If true, no node is created and need is referencing external url.", "field_type": "core", "type": "boolean"}, "is_import": {"default": false, "description": "If true, the need was derived from an import.", "field_type": "core", "type": "boolean"}, "is_modified": {"default": false, "description": "Whether the need was modified by needextend.", "field_type": "core", "type": "boolean"}, "jinja_content": {"default": false, "description": "Whether the content was pre-processed by jinja.", "field_type": "core", "type": "boolean"}, "layout": {"default": null, "description": "Key of the layout, which is used to render the need.", "field_type": "core", "type": ["string", "null"]}, "lineno": {"default": null, "description": "Line number where the need is defined (None if external).", "field_type": "core", "type": ["integer", "null"]}, "links": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "links_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "max_amount": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "max_content_lines": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "modifications": {"default": 0, "description": "Number of modifications by needextend.", "field_type": "core", "type": "integer"}, "my_extra_option": {"default": "", "description": "Custom extra option", "field_type": "extra", "type": "string"}, "params": {"default": "", "description": "Added by service open-needs", "field_type": "extra", "type": "string"}, "parent_need": {"default": null, "description": "Simply the first parent id.", "field_type": "core", "type": ["string", "null"]}, "parent_needs": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "parent_needs_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "parts": {"additionalProperties": {"type": "object"}, "default": {}, "description": "Mapping of parts, a.k.a. sub-needs, IDs to data that overrides the need's data", "field_type": "core", "type": "object"}, "post_content": {"default": null, "description": "Additional content after the need.", "field_type": "core", "type": ["string", "null"]}, "post_template": {"default": null, "description": "The template key, if the post_content was created from a jinja template.", "field_type": "core", "type": ["string", "null"]}, "pre_content": {"default": null, "description": "Additional content before the need.", "field_type": "core", "type": ["string", "null"]}, "pre_template": {"default": null, "description": "The template key, if the pre_content was created from a jinja template.", "field_type": "core", "type": ["string", "null"]}, "prefix": {"default": "", "description": "Added by service open-needs", "field_type": "extra", "type": "string"}, "query": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "section_name": {"default": null, "description": "Simply the first section.", "field_type": "core", "type": ["string", "null"]}, "sections": {"default": [], "description": "Sections of the need.", "field_type": "core", "items": {"type": "string"}, "type": "array"}, "service": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "signature": {"default": null, "description": "Derived from a docutils desc_name node.", "field_type": "core", "type": ["string", "null"]}, "specific": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "starts_after": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "starts_after_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "starts_with": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "starts_with_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "status": {"default": null, "description": "Status of the need.", "field_type": "core", "type": ["string", "null"]}, "style": {"default": null, "description": "Comma-separated list of CSS classes (all appended by `needs_style_`).", "field_type": "core", "type": ["string", "null"]}, "tags": {"default": [], "description": "List of tags.", "field_type": "core", "items": {"type": "string"}, "type": "array"}, "template": {"default": null, "description": "The template key, if the content was created from a jinja template.", "field_type": "core", "type": ["string", "null"]}, "tests": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "tests_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "title": {"description": "Title of the need.", "field_type": "core", "type": "string"}, "triggers": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "triggers_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "tutorial_required_by": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "tutorial_required_by_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "tutorial_specifies": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "tutorial_specifies_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "tutorial_tests": {"default": [], "description": "Link field", "field_type": "links", "items": {"type": "string"}, "type": "array"}, "tutorial_tests_back": {"default": [], "description": "Backlink field", "field_type": "backlinks", "items": {"type": "string"}, "type": "array"}, "type": {"default": "", "description": "Type of the need.", "field_type": "core", "type": "string"}, "type_name": {"default": "", "description": "Name of the type.", "field_type": "core", "type": "string"}, "unit": {"default": "", "description": "Unit specification", "field_type": "extra", "type": "string"}, "updated_at": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "url": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "url_postfix": {"default": "", "description": "Added by service open-needs", "field_type": "extra", "type": "string"}, "user": {"default": "", "description": "Added by service github-issues", "field_type": "extra", "type": "string"}, "value": {"default": "", "description": "General value field", "field_type": "extra", "type": "string"}}, "type": "object"}}}}

docs/builders.rst

@@ -161,7 +161,7 @@ needumls
 The **needumls** builder saves each :ref:`needuml` generated plantuml code to a file, and stores all the files into a single folder during the build.
 The file is created only if the option ``:save:`` from :ref:`needuml` is configured.
 
-The build creates a folder called **needumls** inside the given build-folder, e.g. `_build/needumls`.
+The build creates a folder called **needumls** inside the given build-folder, e.g. ``_build/needumls``.
 
 Usage
 +++++
@@ -196,4 +196,4 @@ Usage
 
 .. code-block:: bash
 
-    sphinx-build -b needs_id source_dir build_dir
+    sphinx-build -b needs_id source_dir build_dir