ginkgo-project
Restructure Documentation
This PR splits the documentation into a part that is generated by sphinx and one that is generated by doxygen. The doxygen part will cover only the reference API documentation, and anything else will be left to sphinx. The full separation is not done in this PR.
Changes:
- adds sphinx configuration
- make doxygen available for sphinx
- simplify doxygen setup
- only the
usrdoc is available, thedevdoc is removed. IMO there is no need for adevdoc, since we can expect developers to look into the Ginkgo source code and discover the documentation there.
- only the
- fix some existing documentation (grouping, markdown files)
- use read-the-docs instead of GH pages to deploy documentation
This is a continuation from #1679. Compared to the previous PR, this has a cleaner integration of doxygen into the documentation build by sphinx.
Link to generated docs: https://ginkgo-test.readthedocs.io/doxysphinx/index.html
Todo:
- move to proper RTD space
Plain program under the example shows empty block. https://ginkgo-test.readthedocs.io/doxysphinx/doxygen/html/simple_solver.html
Plain program under the example shows empty block. https://ginkgo-test.readthedocs.io/doxysphinx/doxygen/html/simple_solver.html
Should be fixed now.
for code ```c++ will give a ++ in the beginning on the section https://ginkgo-test.readthedocs.io/doxysphinx/doxygen/html/group__Executor.html
for code ```c++ will give a ++ in the beginning on the section
It's the same for our current documentation: https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/group__Executor.html#gae20be793db14dfd6249a315281201550. I want to keep changes to the actual text of the documentation out of this PR, so I would not fix this right now.
Error: The following files need to be formatted:
core/solver/ir.cpp
include/ginkgo/core/multigrid/pgm.hpp
You can find a formatting patch under Artifacts here or run format! if you have write access to Ginkgo
