Skip to content

Define Documentation Approach for Rust CodeΒ #7

Open

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

Activity

  1. added theissue type on Jun 5, 2025
  2. dcalavrezo-qorix commented on Nov 27, 2025

    @dcalavrezo-qorix
    Author

    Hi @dcalavrezo-qorix,

    Is this issue still relevant? If not, please add the trash label so it can be marked for deletion.

  3. dcalavrezo-qorix commented on Jun 11, 2026

    @dcalavrezo-qorix
    Author

    @AlexanderLanin yes - it is still relevant

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions