File tree Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Original file line number Diff line number Diff line change
1
+ # docs-as-code
2
+
3
+ Docs-as-code tooling for Eclipse S-CORE
4
+
5
+ ## Overview
6
+
7
+ The S-CORE docs Sphinx configuration and build code.
8
+
9
+ ## Building documentation
10
+
11
+ #### Run a documentation build:
12
+
13
+ #### Integrate latest score main branch
14
+
15
+ ``` bash
16
+ bazel run //docs:incremental_latest
17
+ ```
18
+
19
+ #### Access your documentation at:
20
+
21
+ - ` _build/ ` for incremental
22
+
23
+ #### Getting IDE support
24
+
25
+ Create the virtual environment via ` bazel run //process:ide_support ` .\
26
+ If your IDE does not automatically ask you to activate the newly created environment you can activate it.
27
+
28
+ - In VSCode via ` ctrl+p ` => ` Select Python Interpreter ` then select ` .venv/bin/python `
29
+ - In the terminal via ` source .venv/bin/activate `
30
+
31
+ #### Format your documentation with:
32
+
33
+ ``` bash
34
+ bazel test //src:format.check
35
+ bazel run //src:format.fix
36
+ ```
37
+
38
+ #### Find & fix missing copyright
39
+
40
+ ``` bash
41
+ bazel run //:copyright-check
42
+ bazel run //:copyright.fix
43
+ ```
You can’t perform that action at this time.
0 commit comments