Skip to content

Conversation

@John-P
Copy link
Contributor

@John-P John-P commented Mar 11, 2022

There was a bug in make docs where it would try to remove a directory rm docs/_autosummary without the required -r option. This has been fixed in this PR. Also, a clean-docs command has been added in addition to including generated files in the .gitignore file.

@John-P John-P added bug Something isn't working dev tools Changes/Updates in Development tools labels Mar 11, 2022
@John-P John-P requested review from shaneahmed and vqdang March 11, 2022 12:03
@John-P John-P changed the title DEV: Fix makefile docs DEV: Fix Makefile Docs Command Mar 11, 2022
Copy link
Member

@shaneahmed shaneahmed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please can you address my comment? Otherwise it looks fine to me.

@codecov
Copy link

codecov bot commented Mar 11, 2022

Codecov Report

Merging #316 (865d902) into develop (ca0ece6) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #316      +/-   ##
===========================================
+ Coverage    99.82%   99.84%   +0.02%     
===========================================
  Files           54       55       +1     
  Lines         5146     5169      +23     
  Branches       893      877      -16     
===========================================
+ Hits          5137     5161      +24     
  Misses           2        2              
+ Partials         7        6       -1     
Impacted Files Coverage Δ
tiatoolbox/cli/__init__.py 100.00% <0.00%> (ø)
tiatoolbox/annotation/dsl.py 100.00% <0.00%> (ø)
tiatoolbox/cli/save_tiles.py 100.00% <0.00%> (ø)
tiatoolbox/cli/slide_info.py 100.00% <0.00%> (ø)
tiatoolbox/cli/stain_norm.py 100.00% <0.00%> (ø)
tiatoolbox/cli/read_bounds.py 100.00% <0.00%> (ø)
tiatoolbox/cli/tissue_mask.py 100.00% <0.00%> (ø)
tiatoolbox/annotation/storage.py 100.00% <0.00%> (ø)
tiatoolbox/cli/patch_predictor.py 100.00% <0.00%> (ø)
tiatoolbox/cli/slide_thumbnail.py 100.00% <0.00%> (ø)
... and 4 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 ca0ece6...865d902. Read the comment docs.

@vqdang
Copy link
Contributor

vqdang commented Mar 17, 2022

Have you tested running make doc under root directory rather than ./doc? readthedoc only cares about the make file in the doc if i rmb it right.

@shaneahmed shaneahmed merged commit c5dd408 into develop Mar 23, 2022
@shaneahmed shaneahmed deleted the dev-fix-makefile-docs branch March 23, 2022 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working dev tools Changes/Updates in Development tools

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants