Skip to content

Commit 4e83e56

Browse files
fix: documentation links and update references (#551)
1 parent bb0a656 commit 4e83e56

8 files changed

Lines changed: 27 additions & 63 deletions

File tree

docs/how-to/other_modules.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Example `BUILD` snippet (consumer module):
4848

4949
.. code-block:: starlark
5050
51-
load("@rules_docs//:docs.bzl", "docs")
51+
load("@score_docs_as_code//:docs.bzl", "docs")
5252
docs(
5353
data = [
5454
"@score_process//:needs_json",

docs/how-to/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ designed to enhance documentation capabilities in S-CORE.
2323
Add the module to your `MODULE.bazel` file:
2424

2525
```starlark
26-
bazel_dep(name = "score_docs_as_code", version = "4.0.1")
26+
bazel_dep(name = "score_docs_as_code", version = "4.1.0")
2727
```
2828

2929
And make sure to also add the S-core Bazel registry to your `.bazelrc` file

docs/how-to/source_to_doc_links.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Finally, pass the scan results to the ``docs`` rule as ``scan_code`` attribute.
5353
"foo.py",
5454
"bar.cpp",
5555
"data.yaml",
56-
] + glob(["subdir/**/.py"]),
56+
] + glob(["subdir/**/*.py"]),
5757
)
5858
5959
docs(

docs/internals/extensions/extension_guide.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document will help you with the most important building blocks and provide
66

77
## Getting Started
88

9-
1. Create a new folder in `docs/_tooling/extensions` called `score_<name of your extension>`
9+
1. Create a new folder in `src/extensions` called `score_<name of your extension>`
1010
2. Copy the template inside the `__init__.py`
1111
3. Adapt to your needs
1212

@@ -76,7 +76,7 @@ extensions = [
7676
]
7777
```
7878

79-
> **Important:** There cannot be any BUILD file inside the entire 'extensions' folder, as that would break the Python imports.
79+
> **Important:** Each extension needs its own `BUILD` file to declare the `py_library` target and its dependencies.
8080
8181

8282

@@ -90,16 +90,13 @@ We perform testing with unit tests as well as integration tests that validate th
9090
### Where to Place Your Test Code
9191

9292
```bash
93-
_tooling/
94-
├── extensions/
95-
│ ├── README.md
96-
│ ├── score_draw_uml_funcs/
97-
│ ├── YOUR_EXTENSION/
98-
│ │ ├── __init__.py # your python code (setup needs to be in here)
99-
│ │ ├── xyz.py # your python code (if you need/want to split it across different files)
100-
│ │ └── tests/
101-
│ │ ├── test_xyz.py # unit tests
102-
│ │ └── test_YOUR_EXTENSION.py # integration tests
93+
src/extensions/
94+
├── YOUR_EXTENSION/
95+
│ ├── __init__.py # your python code (setup needs to be in here)
96+
│ ├── xyz.py # your python code (if you need/want to split it across different files)
97+
│ └── tests/
98+
│ ├── test_xyz.py # unit tests
99+
│ └── test_YOUR_EXTENSION.py # integration tests
103100
├── score_metamodel/
104101
├── score_plantuml.py
105102
```

docs/internals/extensions/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
Extensions
2020
==========
2121

22-
Hello there
23-
2422

2523
.. grid:: 1 1 3 3
2624
:class-container: score-grid

docs/internals/extensions/source_code_linker.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -371,14 +371,6 @@ score_source_code_linker/
371371

372372
---
373373

374-
## Clearing Cache Manually
375-
376-
To clear the build cache, run:
377-
378-
```bash
379-
rm -rf _build/
380-
```
381-
382374
## Examples
383375

384376
To see working examples for CodeLinks & TestLinks, take a look at the Docs-As-Code documentation.

docs/internals/requirements/tool_req_overview.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

src/README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,17 @@ It should be treated as a 'get-started' guide, giving you all needed information
5858

5959
```
6060
src/
61-
├── assets/ # Documentation styling (CSS)
62-
├── decision_records/ # Architecture Decision Records (ADRs)
6361
├── extensions/ # Custom Sphinx extensions
64-
│ └── score_metamodel/
65-
│ ├── checks/ # Sphinx-needs validation
66-
│ └── tests/ # Extension test suite
62+
│ ├── score_metamodel/
63+
│ │ ├── checks/ # Sphinx-needs validation
64+
│ │ └── tests/ # Extension test suite
65+
│ ├── score_source_code_linker/
66+
│ ├── score_sphinx_bundle/
67+
│ ├── score_layout/
68+
│ ├── score_draw_uml_funcs/
69+
│ ├── score_plantuml.py
70+
│ └── score_sync_toml/
71+
├── helper_lib/ # Shared utilities
6772
└── templates/ # HTML templates
6873
```
6974

@@ -78,7 +83,7 @@ Find everything related to testing and how to add your own test suite [here](/sr
7883
2. Create a dedicated test directory
7984
3. Include an appropriate README in markdown
8085

81-
> If you want to develop your own Sphinx extension, check out the [extensions guide](/src/extensions/README.md)
86+
> If you want to develop your own Sphinx extension, check out the [extensions guide](/docs/internals/extensions/extension_guide.md)
8287
8388
## Updating dependencies
8489

@@ -101,7 +106,7 @@ bazel run //src:requirements.update -- --upgrade
101106

102107
1. **Documentation**
103108
- Keep READMEs up-to-date
104-
- Document architectural decisions in `decision_records/`
109+
- Document architectural decisions in `docs/internals/decisions/`
105110
- Include examples in extension documentation
106111

107112
2. **Testing**
@@ -129,6 +134,6 @@ Common issues and solutions:
129134
- Verify extension dependencies
130135

131136
## Additional Resources
132-
- [Sphinx extension guide](/src/extensions/README.md)
133-
- [S-CORE Metamodel Documentation](/src/extensions/score_metamodel/README.md)
134-
- [Pytest Integration Guide](/tools/testing/pytest/README.md)
137+
- [Sphinx extension guide](/docs/internals/extensions/extension_guide.md)
138+
- [S-CORE Metamodel Documentation](/docs/internals/extensions/metamodel.md)
139+
- [Pytest Integration Guide](/score_pytest/README.md)

0 commit comments

Comments
 (0)