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

Add docs generation #6

Closed
zec opened this issue Aug 29, 2022 · 1 comment · Fixed by #23
Closed

Add docs generation #6

zec opened this issue Aug 29, 2022 · 1 comment · Fixed by #23
Labels
documentation Improvements or additions to documentation

Comments

@zec
Copy link
Member

zec commented Aug 29, 2022

As a crate which isn't being released on crates.io currently, we don't just get online docs for free from docs.rs. Hand-maintaining generation is tedious and prone to errors of omission; as such, we should probably set up a GitHub workflow for building the docs upon an update of the main branch, generating the HTML and pushing it onto the gh-pages branch.

@zec
Copy link
Member Author

zec commented Apr 14, 2023

...and even if we do end up releasing this on crates.io (which I'd be more amenable to if we figure out a solution to #1), we wouldn't be able to rely on docs.rs to generate our Rustdocs for us, as we rely on cFE and OSAL headers being available.

@zec zec added the documentation Improvements or additions to documentation label Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant