Skip to content

Docs in Markdown with Myst and change tutorials to Jupytext notebooks #355

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

Merged
merged 59 commits into from
Sep 3, 2022

Conversation

basnijholt
Copy link
Member

@basnijholt basnijholt commented Sep 2, 2022

Description

This converts the documentation to Markdown format and uses a new modern theme.

Checklist

  • Fixed style issues using pre-commit run --all (first install using pip install pre-commit)
  • pytest passed

Type of change

Check relevant option(s).

  • 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)
  • (Code) style fix or documentation update
  • This change requires a documentation update

@codecov-commenter
Copy link

codecov-commenter commented Sep 2, 2022

Codecov Report

Merging #355 (f050e01) into master (8b40bf2) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #355      +/-   ##
==========================================
+ Coverage   80.73%   80.75%   +0.01%     
==========================================
  Files          38       38              
  Lines        5071     5071              
  Branches      948      948              
==========================================
+ Hits         4094     4095       +1     
  Misses        833      833              
+ Partials      144      143       -1     
Impacted Files Coverage Δ
adaptive/learner/average_learner1D.py 78.81% <ø> (+0.37%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@basnijholt basnijholt changed the title WIP: Docs in Markdown with Myst and use furo theme Docs in Markdown with Myst and change tutorials to Jupytext notebooks Sep 3, 2022
@basnijholt basnijholt enabled auto-merge September 3, 2022 02:09
@basnijholt basnijholt merged commit 96e0633 into master Sep 3, 2022
@basnijholt basnijholt deleted the cool-new-docs branch September 3, 2022 04:01
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.

2 participants