eclipse-score / eclipse-score/time

Update docs code snippets to be taken from test files

Open
#180 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2
Forks
12
Avg merge
3d 10h
Merged PRs (30d)
24

Description

### What

In the documentation we have hand-written code snippets. These are not compiled, so may fall out of sync with the actual code.

This task is to add files for these code snippets that are built as part of the module build, and then include them directly from the src files in the documentation.

### Acceptance Criteria (DoD)

All code snippets in the user documentation is included from a src file that is built by bazel.

### How

Use sphinx literalinclude rather than hand-written code blocks.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the hand-written snippets in the user documentation and inspecting the module's Bazel build and existing src files. Create built sources for the snippets and replace documentation code blocks with Sphinx literalinclude directives. Done means every user-documentation snippet is included from a src file built by Bazel.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.