CLion

For CLion some of the configuration can be provided via the .clwb directory. But with this approach not all plugins can be configured.

Starlark

For Bazel support the Plugin Bazel needs to be installed from the marketplace.

No further configuration is required here.

Python

For CLion a python interpreter needs to be configured first:

File | Settings | Build, Execution, Deployment | Python Interpreter

Select your system python and as location select the score venv (located in <scorerepo>/.venv_docs)

Sphinx

Code Formatting

A definition of the tab size of .rst files is included in project settings.

Error Highlighting

To provide error handling within the Sphinx Docs build the Plugin LSP4IJ is required. The plugin can be configured using predefined configuration files:

• Download Configuration file from Github

• Navigate to File | Settings | Languages & Frameworks | Language Servers

• Select add language server | Import from Custom Template | select folder which contains downloaded config

Then error highlighting in the source files should be available, maybe a restart is required.

Live Preview

For the preview of the documentation the live preview can be used:

bazel build //docs:live_preview
bazel-bin/docs/live_preview

If the live preview is build and run via the executable with these two separate commands the bazel instance is not blocked in the repository.