Consolidate works cited #145
Labels
documentation
Improvements or additions to documentation
feature-request
New feature request
help wanted
Extra attention is needed
Abstract
It would be nice to have a consolidated list of references for citations to the literature that describes various models implemented in Cantera. This would encourage consistent use of citations within the documentation without bloating the documentation with duplicated reference information.
Motivation
Currently, this is done on a fairly ad-hoc basis, with citations appearing in the documentation for individual C++ classes or methods (e.g.
MixTransport
or on individual pages within the website's "Science" documentation (e.g. reactions). Consolidating these references into a single location would make it easier to add citations from more parts of the documentation without having to duplicate information in many places.Possible Solutions
Doxygen supports the
@cite
command, which can be used to cite references from a Bibtex file and generate a corresponding bibliography.I have not looked into what options exist for Sphinx, or if there is a way to combine this with the citations from Doxygen. One issue with trying to combine the two would be synchronization (or lack thereof) between the code and website repositories.
References
The text was updated successfully, but these errors were encountered: