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

doc-fix: heading hierarchy for Forward Operators section #821

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

hkershaw-brown
Copy link
Member

Description:

Added a ===== to the top level heading so only the top level appears in the table of contents.

Fixes issue

fixes #797

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.

Here is the doc build before:
Screenshot 2025-01-31 at 9 01 17 AM

Here is the doc build after:
Screenshot 2025-01-31 at 9 01 28 AM

"Approaches for Common Situations" and "Parallelism Implementation Details" are now subsections:
Screenshot 2025-01-31 at 9 01 33 AM

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

@hkershaw-brown hkershaw-brown added the release! bundle with next release label Feb 3, 2025
@hkershaw-brown hkershaw-brown changed the base branch from main to cam-se_dry_mass February 3, 2025 13:54
@hkershaw-brown hkershaw-brown merged commit ad0fb84 into cam-se_dry_mass Feb 3, 2025
4 checks passed
@hkershaw-brown hkershaw-brown deleted the doc-fix-sec-headers branch February 3, 2025 13:54
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.

doc: Funky section headers
1 participant