Skip to content

Adding documentaion for pyfortran and pyqceff to pytools page#1054

Merged
hkershaw-brown merged 10 commits intomainfrom
pyfortran_pyqceff_docs
Mar 6, 2026
Merged

Adding documentaion for pyfortran and pyqceff to pytools page#1054
hkershaw-brown merged 10 commits intomainfrom
pyfortran_pyqceff_docs

Conversation

@mjs2369
Copy link
Contributor

@mjs2369 mjs2369 commented Feb 25, 2026

Description:

This PR adds sections to the pytools DART doc page for the python packages pyfortran and pyqceff. The docs discuss the purpose of the packages as well as the available programs and how to use them.

Fixes issue

Fixes #1045

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Please describe any tests you ran to verify your changes.

doc build

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

Copy link
Member

@hkershaw-brown hkershaw-brown left a comment

Choose a reason for hiding this comment

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

Nice Marlee, I put a couple of comments for readabliitly (table of contents for the page & bullet points for pyfortran).

I think pytools should be in the side nav bar (currently pytools is 'hidden')

guide/pytools aftern verifying installation?

DART/index.rst

Lines 255 to 256 in cb85f91

guide/verifying-installation

@hkershaw-brown hkershaw-brown added release! bundle with next release and removed release! bundle with next release labels Feb 26, 2026
mjs2369 and others added 8 commits March 3, 2026 11:35
Co-authored-by: Helen Kershaw <20047007+hkershaw-brown@users.noreply.github.com>
Co-authored-by: Helen Kershaw <20047007+hkershaw-brown@users.noreply.github.com>
Co-authored-by: Helen Kershaw <20047007+hkershaw-brown@users.noreply.github.com>
Co-authored-by: Helen Kershaw <20047007+hkershaw-brown@users.noreply.github.com>
@mjs2369 mjs2369 force-pushed the pyfortran_pyqceff_docs branch from 9e88164 to 64df7c9 Compare March 3, 2026 22:40
@mjs2369
Copy link
Contributor Author

mjs2369 commented Mar 3, 2026

@hkershaw-brown I've addressed all comments, added the doc page to the side bar, and added a table of contents. Ready for re-review

@mjs2369 mjs2369 requested a review from hkershaw-brown March 3, 2026 22:47
Copy link
Member

@hkershaw-brown hkershaw-brown left a comment

Choose a reason for hiding this comment

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

Approved!

@hkershaw-brown hkershaw-brown merged commit 3a09a36 into main Mar 6, 2026
7 checks passed
@hkershaw-brown hkershaw-brown deleted the pyfortran_pyqceff_docs branch March 6, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release! bundle with next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: doc for check_fortran_module_usage and display-qceff-table missing

2 participants