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.

Sign up for GitHub

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

Jump to bottom

Consolidate YAML API documentation in doxygen #1548

Closed
wants to merge 20 commits into from
Closed

Consolidate YAML API documentation in doxygen #1548

wants to merge 20 commits into from

Commits on Jul 19, 2023

  1. [docs] Add YAML API general and phases

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    836dff0 View commit details
    Browse the repository at this point in the history

  2. [docs] Add YAML API elements and species

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    a3a0aec View commit details
    Browse the repository at this point in the history

  3. [docs] Add YAML API reactions

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    cf2b061 View commit details
    Browse the repository at this point in the history

  4. [docs] Add links to conversion utilities to YAML API

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    ab99089 View commit details
    Browse the repository at this point in the history

  5. [docs] Improve coverage-dependent species YAML API

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    68abad7 View commit details
    Browse the repository at this point in the history

  6. [docs] Improve formatting

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    bce6fc7 View commit details
    Browse the repository at this point in the history

  7. [docs] Add YAML format tutorial from cantera-website

    @ischoegl
    ischoegl committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    16c734e View commit details
    Browse the repository at this point in the history

Commits on Jul 20, 2023

  1. [docs] Merge element/species information from website

    @ischoegl
    ischoegl committed Jul 20, 2023
    Configuration menu
    Copy the full SHA
    4759e1e View commit details
    Browse the repository at this point in the history

  2. [docs] Merge phase documentation from website

    @ischoegl
    ischoegl committed Jul 20, 2023
    Configuration menu
    Copy the full SHA
    604d20c View commit details
    Browse the repository at this point in the history

  3. [docs] Merge reaction documentation from website

    @ischoegl
    ischoegl committed Jul 20, 2023
    Configuration menu
    Copy the full SHA
    dc81842 View commit details
    Browse the repository at this point in the history

Commits on Jul 24, 2023

  1. [docs] Standardize Doxygen syntax 

    Use @ to prefix Doxygen commands
    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    0d6da6f View commit details
    Browse the repository at this point in the history

  2. [docs] Port YAML landing page from website

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    bb84a9f View commit details
    Browse the repository at this point in the history

  3. [docs] Improve navigation

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    bf14656 View commit details
    Browse the repository at this point in the history

  4. Move 'new in' information from docs to source

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    b2df3ce View commit details
    Browse the repository at this point in the history

  5. [docs] Remove Sphinx YAML reference

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    b406624 View commit details
    Browse the repository at this point in the history

  6. [docs] Update mainpage

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    4ff70ee View commit details
    Browse the repository at this point in the history

  7. [docs] Use Doxygen format consistently 

    There are differences in output between Doxygen 1.9.1 and 1.9.7,
where the former uses the top-level header as the @page title
automatically. For newer Doxygen versions, those links are broken.

Also, a space in code fencing does not work in newer Doxygen.
    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    9cc5a19 View commit details
    Browse the repository at this point in the history

  8. [docs] Move default unit discussion

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    5d03e3b View commit details
    Browse the repository at this point in the history

  9. [docs] Add pending updates for 3.0

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    b22747b View commit details
    Browse the repository at this point in the history

  10. [docs] Use doxylink to link content from Sphinx

    @ischoegl
    ischoegl committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    24f6787 View commit details
    Browse the repository at this point in the history