5 Commits

Author	SHA1	Message	Date
Graeme Nail	8e659bb5c0	Document Structure (#910) ... * Add architectural outline * Update index	2022-02-08 10:58:09 +00:00
Qianqian Zhu	71b5454b9e	Layer documentation (#892) ... * More examples for MLP layers and docs about RNN layers * Docs about embedding layer and more doxygen code docs * Add layer and factors docs into index.rst * Update layer documentation * Fix typos Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com> Co-authored-by: Graeme Nail <graemenail.work@gmail.com>	2022-01-26 15:17:38 +00: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
Roman Grundkiewicz	8266dbfdfe	Remove doc/install	2021-02-28 08:41:04 +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