Skip to content

Documentation updates for developers/contributors#1700

Merged
speth merged 19 commits intoCantera:mainfrom
speth:docs-2024-04
Jun 2, 2024
Merged

Documentation updates for developers/contributors#1700
speth merged 19 commits intoCantera:mainfrom
speth:docs-2024-04

Conversation

@speth
Copy link
Copy Markdown
Member

@speth speth commented Jun 1, 2024

Changes proposed in this pull request

  • Rewrite the Python and YAML API documentation landing pages to provide a prose introduction with links to specific topics of interest. Previously, these were just auto-generated tables of contents
  • Add several pages to the Develop - Adding New Features to Cantera section of the documentation
    • Integrate the contents of CONTRIBUTING.md into the website
    • Move the code style guidelines into this section
    • New page about writing tests
    • New page about writing examples to work well with Sphinx Gallery
    • New page about running tests and debugging, especially through VS Code
    • New page with general tips for working with VS Code (rescued from the mostly defunct dev-tips repo)
  • Update contributing suggestions, PR/git workflow guidance
  • Describe method for documenting Cython class attributes
  • Use stable version of Sphinx Gallery now that the changes we need have been integrated
  • Update dependencies for building docs
  • Add reference for PLOG formulation
  • Fix some CI issues

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@codecov
Copy link
Copy Markdown

codecov bot commented Jun 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.69%. Comparing base (d37a76b) to head (20390e7).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1700      +/-   ##
==========================================
- Coverage   75.69%   75.69%   -0.01%     
==========================================
  Files         443      443              
  Lines       60975    60970       -5     
  Branches     9551     9551              
==========================================
- Hits        46158    46153       -5     
  Misses      11786    11786              
  Partials     3031     3031              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Copy Markdown
Member

@bryanwweber bryanwweber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all this work @speth!

@speth speth merged commit 06b3500 into Cantera:main Jun 2, 2024
@speth speth deleted the docs-2024-04 branch June 2, 2024 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants