Skip to content
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

Consolidate works cited #145

Closed
speth opened this issue Apr 6, 2022 · 1 comment · Fixed by Cantera/cantera#1631
Closed

Consolidate works cited #145

speth opened this issue Apr 6, 2022 · 1 comment · Fixed by Cantera/cantera#1631
Labels
documentation Improvements or additions to documentation feature-request New feature request help wanted Extra attention is needed

Comments

@speth
Copy link
Member

speth commented Apr 6, 2022

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

@speth speth added documentation Improvements or additions to documentation feature-request New feature request help wanted Extra attention is needed labels Apr 6, 2022
@ischoegl
Copy link
Member

Cantera/cantera#1550 addresses this for references within C++ docstrings. For website "Science" documentation and other content generated by Sphinx, extensions like sphinxcontrib-bibtex or similar should be able to use a shared cantera.bib BibTeX file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature-request New feature request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants