https://github.com/eclipse-score/docs-as-code
Docs-as-code tooling for Eclipse S-CORE
https://github.com/eclipse-score/docs-as-code
Last synced: 5 months ago
JSON representation
Docs-as-code tooling for Eclipse S-CORE
- Host: GitHub
- URL: https://github.com/eclipse-score/docs-as-code
- Owner: eclipse-score
- License: apache-2.0
- Created: 2025-04-28T13:58:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-17T00:17:09.000Z (6 months ago)
- Last Synced: 2026-01-17T04:24:50.736Z (6 months ago)
- Language: Python
- Homepage: https://eclipse-score.github.io/docs-as-code
- Size: 14.7 MB
- Stars: 4
- Watchers: 6
- Forks: 19
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Notice: NOTICE
Awesome Lists containing this project
README
# docs-as-code
Docs-as-code tooling for Eclipse S-CORE
Full documentation is on [GitHub Pages](https://eclipse-score.github.io/docs-as-code/).
> [!NOTE]
> This repository offers a [DevContainer](https://containers.dev/).
> For setting this up read [eclipse-score/devcontainer/README.md#inside-the-container](https://github.com/eclipse-score/devcontainer/blob/main/README.md#inside-the-container).
## Development of docs-as-code
### Getting IDE support for docs-as-code development
Create the virtual environment via `bazel run //:ide_support`.
If your IDE does not automatically ask you to activate the newly created environment you can activate it.
- In VSCode via `ctrl+p` => `Select Python Interpreter` then select `.venv_docs/bin/python`
- In the terminal via `. .venv_docs/bin/activate`
### Format your documentation with:
```bash
bazel test //src:format.check
bazel run //src:format.fix
```
### Find & fix missing copyright
```bash
bazel run //:copyright-check
bazel run //:copyright.fix
```