eclipse-score / eclipse-score/infrastructure

Define Documentation Approach for Rust Code

Open
#7 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
4
Avg merge
1d 3h
Merged PRs (30d)
6

Description

We need to define a consistent approach for documenting Rust code across projects.

Relevant context:
🔗 [Implementation Concept – Units within the Component](https://eclipse-score.github.io/score/main/process/process_areas/implementation/implementation_concept.html#units-within-the-component)

A proposal has been made to evaluate [Sphinx-Rust](https://sphinx-rust.readthedocs.io/en/latest/) for integration into our Sphinx-based documentation toolchain.
Note: The project is currently in alpha, with the latest release dated April 2024.

Tasks:

- [ ] Evaluate Sphinx-Rust for stability and suitability

- [ ] Compare alternatives (e.g., rustdoc, mdBook)
- [ ] Define selection criteria (e.g., integration, maintainability, traceability)
- [ ] Document and communicate the chosen approach

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.