Skip to content

Commit 0256779

Browse files
authored
docs: rename score in documentation (#802)
This commit cleans up the mixture of S-CORE and SCORE. Tooling, repos, pathes and so on remain to have "score". closes #663 Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com>
1 parent c966406 commit 0256779

4 files changed

Lines changed: 23 additions & 24 deletions

File tree

tooling/docs/_tooling/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Score Project Tooling Development Guide
1+
# S-CORE Project Tooling Development Guide
22

3-
*This document is meant for *developers* of the `_tooling` of docs in the score repository.*
3+
*This document is meant for *developers* of the `_tooling` of docs in the score repository.*
44
It should be treated as a 'get-started' guide, giving you all needed information to get up and running.
55

66
## Quick Start
77

8-
1. Clone the repository
8+
1. Clone the repository
99
2. Setup the environment
1010
- *No Devcontainer*
1111
1. Install Bazelisk (version manager for Bazel)
1212
2. Create the Python virtual environment:
1313
```bash
1414
bazel run //docs:ide_support
1515
```
16-
3. Select `.venv_docs/bin/python` as the python interpreter inside your IDE
17-
*Note: This virtual environment does **not** have pip, therefore `pip install` is not available.*
16+
3. Select `.venv_docs/bin/python` as the python interpreter inside your IDE
17+
*Note: This virtual environment does **not** have pip, therefore `pip install` is not available.*
1818
<br>
1919

2020
- *With Devcontainer (VSCode)*
@@ -26,8 +26,8 @@ It should be treated as a 'get-started' guide, giving you all needed information
2626

2727
- **Operating System**: Linux (required)
2828
- **Core Tools**:
29-
- Bazel
30-
- Python
29+
- Bazel
30+
- Python
3131
- Git
3232
- **VSCode** (Optional)
3333
- Several integrations and guides are development primarily with VS Code in mind.
@@ -114,5 +114,5 @@ Common issues and solutions:
114114

115115
## Additional Resources
116116
- [Sphinx extension guide](/docs/_tooling/extensions/README.md)
117-
- [Score Metamodel Documentation](/docs/_tooling/extensions/score_metamodel/README.md)
117+
- [S-CORE Metamodel Documentation](/docs/_tooling/extensions/score_metamodel/README.md)
118118
- [Pytest Integration Guide](/tools/testing/pytest/README.md)

tooling/docs/_tooling/extensions/README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Guide to Creating a Sphinx Extension
22

3-
This document will help you with the most important building blocks and provide all information needed to start writing your own Sphinx extension in the Score project.
3+
This document will help you with the most important building blocks and provide all information needed to start writing your own Sphinx extension in the S-CORE project.
44
**It is intended for developers, it will not show how to use extensions.**
55

66
## Getting Started
@@ -22,8 +22,8 @@ def setup(app: Sphinx) -> dict:
2222
}
2323
```
2424

25-
The `setup` function is vital as this is the one that Sphinx will call when loading your extension.
26-
From here you can attach to different events emitted by Sphinx or sphinx-needs, emit events yourself,
25+
The `setup` function is vital as this is the one that Sphinx will call when loading your extension.
26+
From here you can attach to different events emitted by Sphinx or sphinx-needs, emit events yourself,
2727
or implement the logic needed for your extension to work.
2828

2929
## Attaching to an Event
@@ -37,12 +37,12 @@ def setup(app: Sphinx) -> dict:
3737
```
3838

3939
It's important to ensure that the function you are attaching to the event accepts the correct number of arguments in the right order.
40-
Depending on the event you attach to, some information might not be available, or might be locked.
40+
Depending on the event you attach to, some information might not be available, or might be locked.
4141
Some events also expect a return value.
4242

4343
For more information, please see the related documentation:
4444
- [Attaching function signature](https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.connect)
45-
- [Build API events](https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html#core-events-overview)
45+
- [Build API events](https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html#core-events-overview)
4646
- [sphinx-needs events](https://github.com/useblocks/sphinx-needs/blob/master/docs/contributing.rst#structure-of-the-extensions-logic)
4747

4848
## Adding a New Configuration Value
@@ -55,11 +55,11 @@ def setup(app: Sphinx) -> dict:
5555
...
5656
```
5757

58-
Each configuration value has an associated 'rebuild' value that determines what needs to be rebuilt if this value is changed.
58+
Each configuration value has an associated 'rebuild' value that determines what needs to be rebuilt if this value is changed.
5959
It must be one of these values:
60-
- `'env'`: if a change in the setting only takes effect when a document is parsed - this means that the whole environment must be rebuilt.
61-
- `'html'`: if a change in the setting needs a full rebuild of HTML documents.
62-
- `''`: if a change in the setting will not need any special rebuild.
60+
- `'env'`: if a change in the setting only takes effect when a document is parsed - this means that the whole environment must be rebuilt.
61+
- `'html'`: if a change in the setting needs a full rebuild of HTML documents.
62+
- `''`: if a change in the setting will not need any special rebuild.
6363

6464
More information is available in the [documentation here](https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_config_value).
6565

@@ -122,7 +122,7 @@ For examples on how to use and implement the sphinx testing app, you can check o
122122

123123
Find everything related to testing within bazel and how to add your test suite to it, [see here](/tools/testing/pytest/README.md)
124124

125-
Also look at already built extensions inside Score. They can be found in their respective folders:
125+
Also look at already built extensions inside S-CORE. They can be found in their respective folders:
126126
- [score_metamodel](/docs/_tooling/extensions/score_metamodel/README.md)
127127
- [score_draw_uml_funcs](/docs/_tooling/extensions/score_draw_uml_funcs/__init__.py)
128128

@@ -131,6 +131,5 @@ Also look at already built extensions inside Score. They can be found in their r
131131
- [Sphinx Documentation](https://www.sphinx-doc.org/en)
132132
- [Sphinx Testing Fixture](https://www.sphinx-doc.org/en/master/extdev/testing.html#module-sphinx.testing)
133133
- [Sphinx Needs Documentation](https://sphinx-needs.readthedocs.io/en/latest/)
134-
- [Sphinx Tutorials](https://www.sphinx-doc.org/en/master/development/tutorials/index.html)
134+
- [Sphinx Tutorials](https://www.sphinx-doc.org/en/master/development/tutorials/index.html)
135135
- [Pytest Documentation](https://docs.pytest.org/en/stable/)
136-

tooling/docs/_tooling/extensions/score_metamodel/metamodel-schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$id": "https://example.com/metamodel-schema.json",
4-
"title": "Score Metamodel Schema",
4+
"title": "S-CORE Metamodel Schema",
55
"type": "object",
66
"properties": {
77
"types": {

tooling/docs/_tooling/extensions/score_metamodel/metamodel.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ needs_types:
112112
status: "^(valid|draft)$"
113113
optional_links:
114114
complies: "std_req__(iso26262|isosae21434|isopas8926|aspice_40)__.*$"
115-
# Score Workproduct
115+
# S-CORE Workproduct
116116
workproduct:
117117
title: "Workproduct"
118118
prefix: "wp__"
@@ -145,7 +145,7 @@ needs_types:
145145
status: "^(valid|draft)$"
146146

147147
##############################################################################
148-
# Score Metamodel
148+
# S-CORE Metamodel
149149
##############################################################################
150150
# General
151151
document:
@@ -456,7 +456,7 @@ needs_extra_links:
456456
outgoing: "complies"
457457

458458
##############################################################
459-
# Score Metamodel
459+
# S-CORE Metamodel
460460
##############################################################
461461
# Requirements
462462
satisfies:

0 commit comments

Comments
 (0)