Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Automate doxygen builds #521

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

Merged
Youw merged 6 commits into libusb:master from 2bndy5:automate-doxygen-builds
Apr 5, 2023
Merged

Automate doxygen builds #521

Youw merged 6 commits into libusb:master from 2bndy5:automate-doxygen-builds
Apr 5, 2023

Conversation

@2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Apr 3, 2023
edited
Loading

resolves #5

  • updated the doxyfile using doxygen -u
  • include hidtest/test.c as a doc'd example
  • use a brief doxygen/main_page.md file as the generated site's main page.
  • strip absolute paths from doxygen output (which now displays as relative paths to repo root)
  • added CI to build the docs and save as a CI artifact (useful for visual inspection without checking out a PR branch). This new CI will also rewrite the contents of the gh-pages branch for deployment (only for push events to the master branch).
  • added some missing docstrings and excluded undocumented "helper macros" to satisfy warnings output in doxygen's build log.

Admin prep

The required preparation needed from admins is

  1. make sure the repo's setting are set to use the gh-pages branch root folder as source of deployments.
    image
    I realize that there is already a branch named github_pages, but I think that branch was meant for a different purpose. The branch published to github pages typically only has the site's HTML resources (not any programming or documentation sources) -- especially when using Doxygen as the static site generator.
  2. make sure the custom domain is configured correctly. I mention this one because https://libusb.github.io/hidapi forwards to https://libusb.info/hidapi
  3. add the deployed site's link to the repo's "About" settings:
    image
    Alternatively (or additionally), a link could be added to the README in the "What does the API look like?" section.

@Youw Youw added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 4, 2023
Copy link
Member

Youw commented Apr 4, 2023

I've made a job on master branch, to test CI in this PR.
As for other changes/requests - I'll get to it tiny bit later. Too much preoccupied at the moment.

@Youw Youw self-requested a review April 4, 2023 20:29
@Youw Youw self-assigned this Apr 4, 2023
Copy link
Contributor Author

2bndy5 commented Apr 4, 2023

I realize that there is already a branch named github_pages, but I think that branch was meant for a different purpose. The branch published to github pages typically only has the site's HTML resources (not any programming or documentation sources) -- especially when using Doxygen as the static site generator.

The branch used to publish the docs' site can be configured (see here) Default is a branch named gh-pages.

Copy link
Member

Choose a reason for hiding this comment

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

it always blows my mind how many changes this file gets when it gets updated by doxygen

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TBH, I prefer only having settings in the Doxyfile that don't use the default value. Although, I didn't go through that laborious change here.

Copy link
Member

Youw commented Apr 5, 2023

already a branch named github_pages, but I think that branch was meant for a different purpose

originally it was created for the same purpose as a playground
we just didn't make it right to the end
at this moment I believe it is time to get rid of it

Copy link
Member

Youw commented Apr 5, 2023

2bndy5 reacted with thumbs up emoji

2bndy5 and others added 2 commits April 4, 2023 18:08
Co-authored-by: Ihor Dutchak <ihor.youw@gmail.com>
update links in new md file
use C-style comments
Comment on lines -873 to +995
EXCLUDE_SYMBOLS =
EXCLUDE_SYMBOLS = HID_API_AS_STR_IMPL \
HID_API_AS_STR \
HID_API_TO_VERSION_STR
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the important part that allows eliding specific members from the generated docs. ✏️ Here, I used it to exclude the "helper macros" that don't have a docstring.

Youw reacted with thumbs up emoji
@Youw Youw merged commit e65402f into libusb:master Apr 5, 2023
@Youw Youw mentioned this pull request Apr 5, 2023
@2bndy5 2bndy5 deleted the automate-doxygen-builds branch April 5, 2023 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Youw Youw Youw left review comments

Assignees

@Youw Youw

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

HIDAPI web site

2 participants

AltStyle によって変換されたページ (->オリジナル) /