docs-as-code

Docs-as-code tooling for Eclipse S-CORE

Full documentation is on GitHub Pages.

Note

This repository offers a DevContainer. For setting this up read eclipse-score/devcontainer/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:

bazel test //src:format.check
bazel run //src:format.fix

Find & fix missing copyright

bazel run //:copyright-check
bazel run //:copyright.fix