Skip to content
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

Opensource doc creation #675

Merged
merged 6 commits into from Aug 21, 2021
Merged

Opensource doc creation #675

merged 6 commits into from Aug 21, 2021

Conversation

MaxHalford
Copy link
Member

I've tidied up (a bit) the tool that we use to parse our documentation and convert to it to an MkDocs friendly format. It's here. This PR updates our codebase accordingly.

I think this is a nice step forward because it will allow us (mostly me) to work on the tool independently and share it with others

@codecov-commenter
Copy link

codecov-commenter commented Aug 21, 2021

Codecov Report

Merging #675 (9a78b8f) into master (d1948d0) will decrease coverage by 0.18%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #675      +/-   ##
==========================================
- Coverage   87.62%   87.44%   -0.19%     
==========================================
  Files         321      321              
  Lines       16265    16241      -24     
==========================================
- Hits        14253    14202      -51     
- Misses       2012     2039      +27     
Impacted Files Coverage Δ
river/linear_model/test_glm.py 77.14% <0.00%> (-22.86%) ⬇️
river/tree/nodes/hatc_nodes.py 83.24% <0.00%> (-2.62%) ⬇️
river/metrics/mutual_info.py 96.39% <0.00%> (-0.91%) ⬇️
river/datasets/synth/sea.py 85.71% <0.00%> (-0.65%) ⬇️
river/datasets/synth/concept_drift_stream.py 63.63% <0.00%> (-0.65%) ⬇️
river/datasets/synth/sine.py 83.33% <0.00%> (-0.31%) ⬇️
river/datasets/synth/stagger.py 83.33% <0.00%> (-0.31%) ⬇️
river/utils/skmultiflow_utils.py 77.65% <0.00%> (-0.24%) ⬇️
river/datasets/synth/hyper_plane.py 92.30% <0.00%> (-0.20%) ⬇️
river/datasets/synth/led.py 94.54% <0.00%> (-0.20%) ⬇️
... and 12 more

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 d1948d0...9a78b8f. Read the comment docs.

@MaxHalford MaxHalford merged commit 5c73845 into master Aug 21, 2021
@MaxHalford MaxHalford deleted the opensource-doc-creation branch August 21, 2021 15:38
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.

None yet

2 participants