Skip to content

Migrate Docs pages to Markdown#549

Open
freemansw1 wants to merge 13 commits intotobac-project:mainfrom
freemansw1:migrate_markdown
Open

Migrate Docs pages to Markdown#549
freemansw1 wants to merge 13 commits intotobac-project:mainfrom
freemansw1:migrate_markdown

Conversation

@freemansw1
Copy link
Member

Resolves #535 and migrates all docs pages (other than API docs) to markdown from RST for ease of use and editing in the future.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@freemansw1 freemansw1 added enhancement Addition of new features, or improved functionality of existing features documentation Updates and improvements to documentation and examples labels Dec 23, 2025
@codecov
Copy link

codecov bot commented Dec 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.70%. Comparing base (188046f) to head (97dc5c3).
⚠️ Report is 61 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #549      +/-   ##
==========================================
+ Coverage   63.55%   64.70%   +1.14%     
==========================================
  Files          27       27              
  Lines        3858     3978     +120     
==========================================
+ Hits         2452     2574     +122     
+ Misses       1406     1404       -2     
Flag Coverage Δ
unittests 64.70% <ø> (+1.14%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@github-actions
Copy link

github-actions bot commented Dec 23, 2025

Linting results by Pylint:

Your code has been rated at 8.36/10 (previous run: 8.36/10, +0.00)
The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the main branch.
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.

@freemansw1 freemansw1 added this to the v.1.6.3 milestone Jan 19, 2026
@freemansw1 freemansw1 modified the milestones: v.1.6.3, v1.7.0, v.1.6.4 Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Updates and improvements to documentation and examples enhancement Addition of new features, or improved functionality of existing features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate all docs pages to markdown

1 participant