Skip to content

Doxygen documentation#259

Draft
LecrisUT wants to merge 7 commits intospglib:developfrom
LecrisUT:doxygen
Draft

Doxygen documentation#259
LecrisUT wants to merge 7 commits intospglib:developfrom
LecrisUT:doxygen

Conversation

@LecrisUT
Copy link
Copy Markdown
Collaborator

@LecrisUT LecrisUT commented Mar 3, 2023

Depends on: #258
Closes: #255

Other PR dependencies now are temporary

Currently this one is a bit disjoint. It requires to build both cmake and sphinx-build in a particular fashion:

$ cmake --workflow --preset docs
$ python3 scripts/generate_changelog.py
$ sphinx-build -b html ./doc ./doc/build

Mostly the issue is taking the information of the CMAKE_BUILD_DIR out of cmake and into sphinx. Maybe one alternative is to have cmake call sphinx and the python script.

Relevant page output
2d0ebb5 for an example migration and its output. Simpler still if we combine them to doxygengroup

@LecrisUT LecrisUT marked this pull request as draft March 3, 2023 20:03
@LecrisUT LecrisUT force-pushed the doxygen branch 2 times, most recently from 4dc910a to 6e13ac8 Compare March 3, 2023 20:17
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 3, 2023

Codecov Report

Patch coverage has no change and project coverage change: -11.72 ⚠️

Comparison is base (d826c2d) 85.92% compared to head (502cc42) 74.21%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@             Coverage Diff              @@
##           develop     #259       +/-   ##
============================================
- Coverage    85.92%   74.21%   -11.72%     
============================================
  Files           23       22        -1     
  Lines         6081     5588      -493     
============================================
- Hits          5225     4147     -1078     
- Misses         856     1441      +585     
Flag Coverage Δ
c_api 74.21% <ø> (ø)
fortran_api 37.38% <ø> (ø)
python_api ?

Flags with carried forward coverage won't be shown. Click here to find out more.

see 20 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@LecrisUT LecrisUT force-pushed the doxygen branch 2 times, most recently from f45f966 to c6796a9 Compare March 6, 2023 15:31
@LecrisUT LecrisUT mentioned this pull request Mar 8, 2023
@LecrisUT LecrisUT mentioned this pull request Jun 17, 2023
5 tasks
@LecrisUT LecrisUT force-pushed the doxygen branch 2 times, most recently from 75b9b0a to 73971c0 Compare June 19, 2023 13:56
@LecrisUT LecrisUT self-assigned this Jun 20, 2023
LecrisUT and others added 7 commits June 20, 2023 14:48
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Partially fixes bib reference issue

Signed-off-by: Cristian Le <[email protected]>
There is a dependency hell in the testing environment. For now just see if anything fails on sphinx 7

Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: WIP

Development

Successfully merging this pull request may close these issues.

Doxygen documentaiton

2 participants