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

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.64%. Comparing base (b7abe8d) to head (df49b90).
⚠️ Report is 548 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #259   +/-   ##
========================================
  Coverage    83.64%   83.64%           
========================================
  Files           23       23           
  Lines         6274     6274           
========================================
  Hits          5248     5248           
  Misses        1026     1026           
Flag Coverage Δ
c_api 74.01% <ø> (ø)
fortran_api 36.23% <ø> (ø)
python_api 80.42% <ø> (ø)
unit_tests 74.01% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@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 <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Partially fixes bib reference issue

Signed-off-by: Cristian Le <git@lecris.dev>
There is a dependency hell in the testing environment. For now just see if anything fails on sphinx 7

Signed-off-by: Cristian Le <git@lecris.dev>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
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