Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

eclipse-score/docs-as-code

Open more actions menu

Repository files navigation

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

Enabeling pre-commit

Pre-commit is supported inside docs-as-code to help with code quality and make developers workflow easier.

Install the hook:

pre-commit install

# Or install it to run on pre-push via:
pre-commit install --hook-type pre-push

Execute the pre-commit manually via pre-commit run or pre-commit run --all-files to run it on all files.

About

Docs-as-code tooling for Eclipse S-CORE

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.