Skip to content

Move documenation to MyST. #232

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 37 commits into from
Mar 9, 2022
Merged

Move documenation to MyST. #232

merged 37 commits into from
Mar 9, 2022

Conversation

tobiasraabe
Copy link
Member

@tobiasraabe tobiasraabe commented Mar 7, 2022

Changes

This PR moves the documentation to MyST because

  • for most people it is easier to write markdown.
  • https://mdformat.readthedocs.io/ allows to format the documentation although we cannot use it right now since it cannot handle admonitions. we keep an eye on it.

@tobiasraabe tobiasraabe added this to the v0.2.0 milestone Mar 7, 2022
@tobiasraabe tobiasraabe changed the base branch from main to implement-new-parametrizations March 7, 2022 11:13
Base automatically changed from implement-new-parametrizations to main March 7, 2022 12:07
@codecov
Copy link

codecov bot commented Mar 9, 2022

Codecov Report

Merging #232 (529a3a8) into main (3e41ebd) will decrease coverage by 0.02%.
The diff coverage is 60.00%.

❗ Current head 529a3a8 differs from pull request most recent head dcd7e1d. Consider uploading reports for the commit dcd7e1d to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #232      +/-   ##
==========================================
- Coverage   94.37%   94.35%   -0.03%     
==========================================
  Files          79       79              
  Lines        6956     6961       +5     
==========================================
+ Hits         6565     6568       +3     
- Misses        391      393       +2     
Flag Coverage Δ
end_to_end 80.17% <60.00%> (-0.02%) ⬇️
integration 41.74% <20.00%> (-0.02%) ⬇️
unit 69.38% <20.00%> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
src/_pytask/capture.py 90.33% <ø> (ø)
src/_pytask/mark/expression.py 98.36% <ø> (ø)
tests/test_graph.py 95.60% <60.00%> (-2.08%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e41ebd...dcd7e1d. Read the comment docs.

@tobiasraabe tobiasraabe merged commit f3ed80b into main Mar 9, 2022
@tobiasraabe tobiasraabe deleted the move-to-myst branch March 9, 2022 20:45
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