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.

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

Host Rustdoc documentation on the project website #76

Open
dominic-mulligan-arm opened this issue Feb 5, 2021 · 0 comments
Open

Host Rustdoc documentation on the project website #76

dominic-mulligan-arm opened this issue Feb 5, 2021 · 0 comments
Labels
build-process Something related to the Veracruz build process enhancement New feature or request help wanted Extra attention is needed

Comments

@dominic-mulligan-arm
Copy link
Member

Requested feature
The Rustdoc documentation present in the code should be automatically generated and hosted somewhere accessible, e.g. the Veracruz project website.

Motivation
At the moment, we have patchy Rustdoc coverage (there's another, existing issue open to try to improve this) but no way of browsing what documentation exists easily. To do this at present, you have to first generate the documentation build manually, and then open a browser at target/doc/package_name/index.html to see the generated documentation. It would be better to just have this done automatically and the documentation hosted on the user's behalf.

Additional context
See also issue #29 which aims to add build targets for Rustdoc to the project Makefiles.

@dominic-mulligan-arm dominic-mulligan-arm added enhancement New feature or request help wanted Extra attention is needed build-process Something related to the Veracruz build process labels Feb 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-process Something related to the Veracruz build process enhancement New feature or request help wanted Extra attention is needed
Projects
No open projects
Development

No branches or pull requests

1 participant