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

Documentation updates #1572

Merged
merged 15 commits into from
Aug 7, 2023
Merged

Documentation updates #1572

merged 15 commits into from
Aug 7, 2023

Commits on Aug 6, 2023

  1. [CI] Build docs with Sphinx 5.1.1 

    Sphinx 3.x isn't compatible with our Nikola plugins, and the old
extension compatibility issues with 4.x no longer hold.

Sphinx 5.1.1 seems to be the most recent version that doesn't have
formatting issues for us.

Resolves Cantera/enhancements#175
    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    2d0e2f3 View commit details
    Browse the repository at this point in the history

  2. Remove obsolete Doxygen options 

    These options generate warnings with Doxygen 1.9.6
    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    adb6fa8 View commit details
    Browse the repository at this point in the history

  3. [Doc] Fix alphabetization of phase models

    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    1aa6169 View commit details
    Browse the repository at this point in the history

  4. [Doc] Note version added for recent ThermoPhase models

    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    efd7eba View commit details
    Browse the repository at this point in the history

  5. [Doc] Use Doxylink to link to C++ classes 

    No need to link directly to the "details" section since that now
appears close to the top of the page.
    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    84aa1c7 View commit details
    Browse the repository at this point in the history

  6. [Doc] Remove broken link to non-existent Electrochemical reaction type

    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    ea3d944 View commit details
    Browse the repository at this point in the history

  7. [Doc] Revise ThermoPhase documentation 

    Extract content from "thermoprops.dox" to populate the docstring for
the ThermoPhase class and the "thermoprops" group.

Fix numerous areas where this documentation was outdated or incorrect.
    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    8d442a0 View commit details
    Browse the repository at this point in the history

  8. [Doc] Remove admonition about testing from MixtureFugacityTP 

    The classes derived from this (RedlichKwongMFTP and PengRobinson)
have adequate tests.
    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    ccd749f View commit details
    Browse the repository at this point in the history

  9. [Doc] Fix obsolete references to SimpleThermo

    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    770dd3a View commit details
    Browse the repository at this point in the history

  10. [Doc] Fix notation for natural log 

    Always write \log_{10} in the rare instances where that's what's
actually meant.
    @speth
    speth committed Aug 6, 2023
    Configuration menu
    Copy the full SHA
    5cbb5f7 View commit details
    Browse the repository at this point in the history

Commits on Aug 7, 2023

  1. [Doc] Reduce clutter in C++ member function docs

    @speth
    speth committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    104fed6 View commit details
    Browse the repository at this point in the history

  2. [Doc] Remove obsolete reference to CA_Mode

    @speth
    speth committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    91ffef4 View commit details
    Browse the repository at this point in the history

  3. [Doc] Update citations for some transport classes

    @speth
    speth committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    de7c349 View commit details
    Browse the repository at this point in the history

  4. Delete duplicated documentation

    @speth
    speth committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    1caf6ce View commit details
    Browse the repository at this point in the history

  5. [Doc] Fix some spelling errors

    @speth
    speth committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    ef568b1 View commit details
    Browse the repository at this point in the history