Skip to content

Define Documentation Approach for Rust CodeΒ #7

@dcalavrezo-qorix

Description

@dcalavrezo-qorix

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

Relevant context:
πŸ”— Implementation Concept – Units within the Component

A proposal has been made to evaluate Sphinx-Rust 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No fields configured for Task.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions