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

Publish rustdocs to GitHub Pages #149

Open
daprilik opened this issue Oct 18, 2024 · 0 comments
Open

Publish rustdocs to GitHub Pages #149

daprilik opened this issue Oct 18, 2024 · 0 comments
Labels
CI Improvements or additions to our CI setup outside of flowey documentation Improvements or additions to documentation flowey Improvements to the flowey build infrastructure

Comments

@daprilik
Copy link
Contributor

We are already running cargo doc in our CI infrastructure, but we are not currently publishing those docs on GitHub pages.

This should be relatively straightforward to do in our existing pipelines, with the only nuanced bit being that we'd need to "splice" the HTML generated by rustdoc into the HTML generated by the mdbook-based OpenVMM Guide. e.g: having the Guide link to a _rustdoc/ folder, which the build system copies into the book/ folder prior to publishing to GitHub pages.

In addition, we may want to compile the rustdocs on both Windows and Linux (and possibly even x86 and Aarch64), and include multiple versions in the final HTML.

@daprilik daprilik added CI Improvements or additions to our CI setup outside of flowey documentation Improvements or additions to documentation labels Oct 18, 2024
@daprilik daprilik added the flowey Improvements to the flowey build infrastructure label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Improvements or additions to our CI setup outside of flowey documentation Improvements or additions to documentation flowey Improvements to the flowey build infrastructure
Projects
None yet
Development

No branches or pull requests

1 participant