Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Add a build target to generate Rustdoc documentation files #29

Open
dominic-mulligan-arm opened this issue Nov 4, 2020 · 1 comment
Open

Add a build target to generate Rustdoc documentation files #29

dominic-mulligan-arm opened this issue Nov 4, 2020 · 1 comment
Labels
build-process Something related to the Veracruz build process documentation Improvements or additions to documentation enhancement New feature or request
Projects
Technical tasks

Comments

@dominic-mulligan-arm
Copy link
Member

There are Rustdoc comments sprinkled throughout the Veracruz codebase, but these are not currently being built into browsable documentation as part of the Veracruz build process. We should add a new build target to generate this documentation, which will make the project easier to understand for newcomers.
@dominic-mulligan-arm dominic-mulligan-arm added documentation Improvements or additions to documentation enhancement New feature or request build-process Something related to the Veracruz build process labels Nov 4, 2020
@dominic-mulligan-arm dominic-mulligan-arm mentioned this issue Nov 4, 2020
Open
@dominic-mulligan-arm
Copy link
Member Author

(Reported by @basmaelgaabouri.)

@dominic-mulligan-arm dominic-mulligan-arm mentioned this issue Nov 9, 2020
Merged
@dominic-mulligan-arm dominic-mulligan-arm moved this from To do to In progress in Technical tasks Nov 9, 2020
@dominic-mulligan-arm dominic-mulligan-arm mentioned this issue Feb 5, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
build-process Something related to the Veracruz build process documentation Improvements or additions to documentation enhancement New feature or request
Projects
No open projects
Technical tasks
In progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dominic-mulligan-arm