Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Review and complete GNATdoc content #21

Open
torsknod2 opened this issue Feb 16, 2025 · 1 comment
Open

Review and complete GNATdoc content #21

torsknod2 opened this issue Feb 16, 2025 · 1 comment
Labels
aspice-relevant Reduces ASPICE gaps documentation Improvements or additions to documentation enhancement New feature or request
Milestone
0.1.0

Comments

@torsknod2
Copy link
Owner

Review the existing GNATdoc documentation and complete it.
Ensure to be as near as possible to IEEE 1788 standard documents and reference the relevant places.
Manual for GNATdoc: https://www.adacore.com/documentation/gnatdoc-users-guide
@codeautopilot CodeAutopilot
Copy link

codeautopilot bot commented Feb 16, 2025

Your organization has reached the subscribed usage limit. You can upgrade your account by purchasing a subscription at Stripe payment link

This comment was generated by AI. Information provided may be incorrect.

Current plan usage: 100%

Have feedback or need help?
Documentation
support@codeautopilot.com

@torsknod2 torsknod2 mentioned this issue Feb 16, 2025
Merged
torsknod2 added a commit that referenced this issue Feb 16, 2025
@torsknod2
#6: Add GNATdoc documentation generation and enhance IEEE 1788 packag…
14af0d8 
…e documentation (#17)

This PR closes #6 and support #19 by implementing documentation
generation using GNATdoc and enhances the overall documentation of the
IEEE 1788 package.

The changes include:

# Documentation Generation
- Added GNATdoc to generate documentation in both HTML and RST formats
- Added conversion of RST documentation to multiple formats (HTML,
LaTeX)
- Added necessary dependencies: `docutils` and `sphinxcontrib-adadomain`

# Code Changes
- Enhanced IEEE 1788 package documentation with comprehensive function
descriptions
- Updated project files to support documentation generation
- Reorganized test suites for better maintainability
- Added VSCode settings for improved Ada development experience

# CI/CD Updates
- Added new CI/CD jobs for documentation generation and conversion
- Enhanced test coverage reporting

# Further work
- #20 was created to close the remaining infrastructure topics in
generating target document formats out of the rst files.
- #21 was created to review and close gaps of `GNATdoc` relevant
comments

---------

Co-authored-by: Torsten Knodt <torsten.knodt@datas-world.de>
@torsknod2 torsknod2 added this to the 0.1.0 milestone Feb 18, 2025
@torsknod2 torsknod2 added aspice-relevant Reduces ASPICE gaps documentation Improvements or additions to documentation enhancement New feature or request labels Feb 18, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
aspice-relevant Reduces ASPICE gaps documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
0.1.0
Development

No branches or pull requests
1 participant
@torsknod2