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

Cantera website - increase doxylink use in Sphinx documentation #182

Open
ischoegl opened this issue Aug 9, 2023 · 0 comments
Open

Cantera website - increase doxylink use in Sphinx documentation #182

ischoegl opened this issue Aug 9, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation feature-request New feature request

Comments

@ischoegl
Copy link
Member

ischoegl commented Aug 9, 2023

Problem description

We keep getting inquiries on the UG about where different parts of Cantera functions are implemented. For this, it would be beneficial to increase the use of doxylinks in the documentation (as an aside, this was one item I attempted to resolve in Cantera/cantera#1548 for the YAML API documentation).

As a somewhat related example, there is a reference for InterfaceRate->coverage-dependencies that could benefit from reformatting (although it may be preferable to link to the corresponding C++ documentation and doxygen @cite the reference there).

image
@ischoegl ischoegl transferred this issue from Cantera/cantera Aug 9, 2023
@ischoegl ischoegl added documentation Improvements or additions to documentation feature-request New feature request labels Aug 9, 2023
@ischoegl ischoegl changed the title Cantera 3.0 website - use doxylink in YAML documentation Cantera 3.0 website - increase doxylink use in YAML documentation Aug 9, 2023
@ischoegl ischoegl changed the title Cantera 3.0 website - increase doxylink use in YAML documentation Cantera website - increase doxylink use in YAML documentation Aug 9, 2023
@ischoegl ischoegl changed the title Cantera website - increase doxylink use in YAML documentation Cantera website - increase doxylink use in Sphinx documentation Aug 9, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant