Skip to content

doc/doxygen: print link to generated documentation#20896

Merged
miri64 merged 1 commit intoRIOT-OS:masterfrom
mguetschow:doc-print-link
Oct 8, 2024
Merged

doc/doxygen: print link to generated documentation#20896
miri64 merged 1 commit intoRIOT-OS:masterfrom
mguetschow:doc-print-link

Conversation

@mguetschow
Copy link
Copy Markdown
Contributor

Contribution description

It can be confusing for new users where to find the HTML documentation generated with make doc. This PR prints the link to the index.html after successful generation.

Testing procedure

make doc

also, CI should not be confused with these changes

@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 8, 2024
@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Oct 8, 2024
@mguetschow mguetschow requested a review from benpicco October 8, 2024 09:27
@riot-ci
Copy link
Copy Markdown

riot-ci commented Oct 8, 2024

Murdock results

✔️ PASSED

306b8a8 doc/doxygen: print link to generated documentation

Success Failures Total Runtime
1 0 1 01m:28s

Artifacts

Copy link
Copy Markdown
Member

@miri64 miri64 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK

@miri64 miri64 added this pull request to the merge queue Oct 8, 2024
Merged via the queue into RIOT-OS:master with commit 1c9a485 Oct 8, 2024
@mguetschow mguetschow deleted the doc-print-link branch October 9, 2024 07:58
@benpicco benpicco added this to the Release 2024.10 milestone Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants