CI: build preview documentation with the same doxygen version as the website#21295
Closed
Baertig wants to merge 1 commit intoRIOT-OS:masterfrom
Closed
CI: build preview documentation with the same doxygen version as the website#21295Baertig wants to merge 1 commit intoRIOT-OS:masterfrom
Baertig wants to merge 1 commit intoRIOT-OS:masterfrom
Conversation
gh-actions: change compression level to 0
github-actions
bot
added
the
Area: CI
Baertig
force-pushed
the
ci/add_create_doc_workflow
branch
from
cd419d5 to
93c3256
Compare
Contributor
|
After thinking about this a lot, I had the idea to integrate Doxygen as a tool in the RIOT To make it a bit easier to understand I created this PR: #21300 This is very much up for debate, but I thought it would be easier to create the PR to picture what the idea is. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contribution description
Currently the preview documentation (e.g. here) is build with another doxygen version then the website (https://doc.riot-os.org/).
To deploy the website this Dockerfile is used: OlegHahm/docker-doxygen, but to build the preview we use the riot/murdock-scripts:latest docker image.
I think it would be best if both are build with the same image, so that the doxygen version can be maintained in only one place. Therefor I added a github workflow, that uses the docker-doxygen image to build the documentation and publish it as an artifact.
Limitations: currently you can only preview the documentation locally, by downloading and unzipping the artifact.
I am trying to figure out a good way to provide a preview, that one can view directly in the browser without downloading. (that's why it is in draft)
Testing procedure
You can check how it would look like in this example PR in my fork: Baertig#1
(click on
checksand then onpreview-documentation)Issues/PRs references
Fixes #21106