Enable local build of doc incl. c/c++ api #86
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ozaq
added
documentation
tbkr
reviewed
Feb 17, 2025
docs/conf.py
Outdated
|
|
||
| project = "fdb" | ||
| project = "Fields DataBase - FDB" | ||
| copyright = "2025, ECMWF" |
There was a problem hiding this comment.
The moving copyright year was removed here. Shall we keep it?
There was a problem hiding this comment.
What's the correct year to start with?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #86 +/- ##
========================================
Coverage 61.60% 61.60%
========================================
Files 275 275
Lines 15244 15244
Branches 1558 1558
========================================
Hits 9391 9391
Misses 5853 5853 ☔ View full report in Codecov by Sentry. |
Ozaq
force-pushed
the
automate-doc-generation
branch
2 times, most recently
from
815c67f to
8ea35db
Compare
To enable local documentation build set cmake option
FDB5_ENABLE_DOCUMENTATION=ON
This will require Doxygen 1.13 and sphinx and its requirements.
Sphinx and deps can installed via pip from docs/requirements.txt
After succefull cmake configuration a new target fdb-doc will be
added. This new target it part of 'all'.
Ozaq
force-pushed
the
automate-doc-generation
branch
from
c0d367c to
941fade
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To enable local documentation build set cmake option
FDB5_ENABLE_DOCUMENTATION=ON
This will require Doxygen 1.13 and sphinx and its requirements. Sphinx and deps can installed via pip from docs/requirements.txt
After succefull cmake configuration a new target fdb-doc will be added. This new target it part of 'all'.