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
Automate releasing documentation #12
Comments
@Erikvv could you add more details how we can do this? |
High level:
Note: we currently only host documentation for one tag, which would have to be the latest. I was looking at processing the Doxygen XML output with Breath+Sphinx to support this and maybe other improvements. |
Note, it might be easier to do with github actions. You can setup a github action something like:
Adjust the |
Also, I think ideally we would want to generate the docs for all versions. But, in general, since the docs are minimal here, I would stuff together a golang templates rather than creating a huge documentation pipeline. |
What do you mean by this? |
Rather than requiring Doxygen + other stuff, it shouldn't be too difficult to put together But, using Doxygen is also completely fine. |
So to scope the issue:
|
I tried out the Doxygen+Breathe+Sphinx pipeline to generate better docs for Uplink-C than pure Doxygen. I didn't want to start on this issue before investigating this. My conclusion is that these are good tools when you want to put effort to write very good documentation like on readthedocs.io and still be able to reference structs and functions in the code, but it is a regression in terms of automatic generation of API docs. If anyone wants to put in the effort I can certainly recommend it, I have a branch saved. So I should just do what I described before to automate Doxygen. |
Would be nice to automatically generate/deploy a new version of documentation after each release.
The text was updated successfully, but these errors were encountered: