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.

Sign up for GitHub

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

Jump to bottom

Docs/doxy and make deploy #290

Merged
merged 7 commits into from
Dec 24, 2024
Merged

Docs/doxy and make deploy #290

merged 7 commits into from
Dec 24, 2024

Conversation

nathanjhood
Copy link
Member

What kind of change does this PR introduce?

  • Added a full CMake/ninja configure process
  • Updated Doxyfile to scan configured headers from the build directory, in order to populate information that I don't want to self-manage (version numbers, etc)
  • the docs page is now quite fully-featured, all aside from linking to the VCV Rack and StoneyDSP doxygen sites, which is only possible if they implement support (Doxygen "TAGFILES") on their side, which I have no control over with regards to VCV Rack...

@nathanjhood
edit '.github/workflows/static.yml' - run doxygen from base dir
fa1cde3 
Signed-off-by: Nathan <[email protected]>
@nathanjhood
edit '.github/workflows/static.yml' - fetch vcpkg and configure with …
3c87f7d 
…CMake, use configured build dir

Signed-off-by: Nathan <[email protected]>
@nathanjhood
edit '.github/workflows/static.yml' - remove j3 arg, use env vars
17a190f 
Signed-off-by: Nathan <[email protected]>
@nathanjhood
edit '.github/workflows/static.yml' - use VCPKG_ROOT
4193a32 
Signed-off-by: Nathan <[email protected]>
@nathanjhood
edit '.github/worklfows/static.yml' - install ninja and CMake
58dc0c7 
Signed-off-by: Nathan <[email protected]>
@nathanjhood
edit '.github/workflows/static.yml' - install ninja-build not ninja
e66e715 
Signed-off-by: Nathan <[email protected]>
@nathanjhood
edit '.github/workflows/static.yml' - install graphviz for dot
942e467 
Signed-off-by: Nathan <[email protected]>
@nathanjhood nathanjhood added the documentation Improvements or additions to documentation label Dec 24, 2024
@nathanjhood nathanjhood self-assigned this Dec 24, 2024
@nathanjhood nathanjhood merged commit 9a202e7 into development Dec 24, 2024
4 checks passed
@nathanjhood nathanjhood deleted the docs/doxy-and-make-deploy branch December 24, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@nathanjhood nathanjhood

Labels
documentation Improvements or additions to documentation
Projects
StoneyDSP
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@nathanjhood