You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: tooling/docs/_tooling/extensions/README.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Guide to Creating a Sphinx Extension
2
2
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.
4
4
**It is intended for developers, it will not show how to use extensions.**
5
5
6
6
## Getting Started
@@ -22,8 +22,8 @@ def setup(app: Sphinx) -> dict:
22
22
}
23
23
```
24
24
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,
27
27
or implement the logic needed for your extension to work.
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.
59
59
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.
63
63
64
64
More information is available in the [documentation here](https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_config_value).
65
65
@@ -122,7 +122,7 @@ For examples on how to use and implement the sphinx testing app, you can check o
122
122
123
123
Find everything related to testing within bazel and how to add your test suite to it, [see here](/tools/testing/pytest/README.md)
124
124
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:
0 commit comments