Skip to content

Conversation

@AndreasAlbertQC
Copy link
Collaborator

@AndreasAlbertQC AndreasAlbertQC commented Oct 17, 2025

Motivation

Markdown is easier to write than rst.

Changes

  • Configured sphinx to parse markdown
  • Changed existing docs to use markdown
  • Added reference to relevant myst docs to the development section of the docs so that developers can read up on the syntax

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 17, 2025
@codecov
Copy link

codecov bot commented Oct 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (545f177) to head (9206f42).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #170   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           51        50    -1     
  Lines         2913      2901   -12     
=========================================
- Hits          2913      2901   -12     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AndreasAlbertQC AndreasAlbertQC marked this pull request as ready for review October 17, 2025 09:30
@AndreasAlbertQC AndreasAlbertQC merged commit 33398d7 into main Oct 17, 2025
22 checks passed
@AndreasAlbertQC AndreasAlbertQC deleted the 2025-10-17_markdown branch October 17, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants