Skip to content

Feature/adopt md - #28

Merged
laurejt merged 22 commits into
developfrom
feature/adopt-md
May 1, 2026
Merged

laurejt merged 22 commits into
developfrom
feature/adopt-md

Conversation

@laurejt

@laurejt laurejt commented Apr 29, 2026

Copy link
Copy Markdown
Contributor

Associated Issue(s): resolves #22, #24

Changes in this PR

  • Convert sphinx-docs files from .rst to .md
  • Add sphinx-docs-coverage.yml GitHub Action for checking doc coverage
  • Add mdformat pre-commit hook
  • Remove support for Django versions past end-of-life (3.2, 4.0, 4.1, 4.2, 5.0) and add support for version 5.2, 6.0
  • Update yamlfmt config (set in-line comment padding to 2)
  • Update CHANGELOG.md
  • Update pyproject.toml
  • Update uv.lock
  • Add concurrency logic to all GitHub Actions
  • Update CodeQL GitHub Action to current template

Notes

  • I had to explicitly indicate the file type of .md files within sphinx-docs/conf.py, otherwise sphinx was treating these as reStructuredText

Reviewer Checklist

  • Confirm that docs' contents have been preserved
  • Confirm that readme and changelog contents have been preserved
  • Check that docs can be built locally without error
  • Check that changelog updates are legible and sufficient

@laurejt
laurejt requested a review from rlskoeser April 29, 2026 18:11
@codecov

codecov Bot commented Apr 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.66%. Comparing base (2d4375d) to head (b400757).
⚠️ Report is 76 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop      #28      +/-   ##
===========================================
- Coverage   100.00%   96.66%   -3.34%     
===========================================
  Files            8        8              
  Lines          312      360      +48     
  Branches         0       15      +15     
===========================================
+ Hits           312      348      +36     
- Misses           0        7       +7     
- Partials         0        5       +5     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@laurejt
laurejt marked this pull request as draft April 29, 2026 18:30
@laurejt
laurejt marked this pull request as ready for review April 29, 2026 18:53
@github-advanced-security

Copy link
Copy Markdown
Contributor

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

Comment thread .github/workflows/sphinx-docs-coverage.yml Fixed
…ntain permissions'

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

@rlskoeser rlskoeser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All the changes look great. Docs built fine locally once I installed the new dependencies.

Comment thread sphinx-docs/index.md Outdated
Comment thread README.md Outdated
laurejt and others added 2 commits May 1, 2026 11:29
Co-authored-by: Rebecca Sutton Koeser <rlskoeser@users.noreply.github.com>
@laurejt
laurejt merged commit bc2f9a3 into develop May 1, 2026
40 of 41 checks passed
@laurejt
laurejt deleted the feature/adopt-md branch May 1, 2026 19:03
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.

3 participants