-
Notifications
You must be signed in to change notification settings - Fork 168
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
Documentation using Sphinx+Exhale+Doxygen (revised) #197
Conversation
@paulgessinger I still need to do a few content fixes but you can already start to have a look. |
Codecov Report
@@ Coverage Diff @@
## master #197 +/- ##
==========================================
+ Coverage 44.22% 44.66% +0.44%
==========================================
Files 365 369 +4
Lines 18239 18454 +215
Branches 8691 8782 +91
==========================================
+ Hits 8066 8243 +177
+ Misses 4928 4874 -54
- Partials 5245 5337 +92
Continue to review full report at Codecov.
|
Co-authored-by: Paul Gessinger <hello@paulgessinger.com>
@paulgessinger @HadrienG2 @asalzburger This is now ready to go in. I updated the content a bit and streamlined the |
Codecov seems not to post the results, and I'm not sure what's wrong with the review check. I'm overriding this. |
* cmake: add FindSphinx * cmake: doc requires sphinx * doc: doxygen builds only xml * doc: build w/ Sphinx * doc: add layout and move existing content * doc: build full api doc with exhale * doc: do not build doxygen html * doc: add authors and license * doc: update logo * doc: import modules and integration content * doc: simplify navbar * doc: add unit documentation * doc: move utilities into sub-folder * doc: fixes to units * doc: adjust doc cmakelists * cmake: split doc generation into separate commands * doc: update some paths * doc: update doxygen config * doc: update requirements * move the getting started guide to docs * doc: remove doxygen layout * doc: simplify cmake config * doc: reorganize files * move docs * doc: add pip requirements file * cmake: add run-doxygen debug target * docs: update Doxygen config * docs: import truth tracking howto from framework * docs: use consistent rst format * docs: re-use AUTHORS file * Update docs/core/material.rst Co-authored-by: Paul Gessinger <hello@paulgessinger.com> * docs: add filesystem to boost packages * move authors to docs * ci: add docs build job * gitignore: do not ignore github configs * docs: always enable doxygen on RTD * docs: exclude build directory * add readthedocs config * Examples: minor README fixes * Fatras: minor README fixes * thirdparty: consistent README formatting * docs: streamline index text * streamline README Co-authored-by: Paul Gessinger <hello@paulgessinger.com>
This moves the documentation build to use Sphinx with the Breathe/Exhale extensions. Doxygen is called automatically by Sphinx and is used only to extract the existing source code documentation.
docs
directory in this repository.README.md
is streamlined and contains mostly usage and code organization information and provides links to other sources to avoid duplication.Please note:
make docs
, uses a fixed path in-source build (in contrast to the configurable out-of-source build directory for the code) to be compatible with https://readthedocs.org. You might need to removedocs/{_build,api}
manually for a clean build.make docs-without-doxygen
target is available that only builds the manually written parts. Amake run-doxygen
target is available to run doxygen standalone to simplify debugging the Doxygen config.This is an updated versions of https://gitlab.cern.ch/acts/acts-core/-/merge_requests/614.
Closes #44 and supersedes/closes #96.