Commit Graph

4 Commits

Author SHA1 Message Date
Graeme Nail
95720ae19f
Update NVIDIA CUDA signing key for CI; fix for building docs (#932)
* Update NVIDIA CUDA signing key for CI
* Constrain Jinja2 to build docs
2022-05-18 11:11:28 +01:00
Qianqian Zhu
cd9afea8d3
Documentation about how to write code documentation (#891)
* add initial guidelines of code documentation
* fix math formula not displayed in Sphinx
* remove @name tags which cannot be extracted by exhale and cause function signature errors
* fix markdown ref warning and update markdown parser in sphinx
* more about doxygen: add Doxygen commands and math formulas
* move code doc guide to a new .rst file
* add formula image
* Set myst-parser version appropriate for the requested sphinx version
* Update documentation on how to write Doxygen comments
* Add new section to the documentation index
* Sphinx 2.4.4 requires myst-parser 0.14
* complete code doc guide and small fixes on reStructuredText formats
* More about reStructuredText
* Update badges on the documentation frontpage

Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com>
2021-12-07 15:10:46 +00:00
Graeme Nail
c64cb2990e
Constrain version of mistune to before v2 in GitHub CI Documentation builds (#894) 2021-12-06 14:06:14 +00:00
Roman Grundkiewicz
f88ded2ba8
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803)
* Setup Sphinx+Doxygen+Breathe+Exhale
* Remove links to modindex and search pages
* Enable Doxygen autobrief
2021-02-23 16:25:30 +00:00