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

docs: Restructured documentation #519

Merged
merged 4 commits into from
Oct 1, 2021
Merged

docs: Restructured documentation #519

merged 4 commits into from
Oct 1, 2021

Conversation

fg-mindee
Copy link
Contributor

This PR introduces the following modifications:

  • removes the mention that PyTorch is in beta in the README
  • in the documentation, split benchmark & export model from actual docstrings: "Using DocTR" section doesn't include any function/class documentation but explains how some features work and provides benchmarks. Hyperlinks were added so that users can easily access the signature.

Here is the new navigation menu:
image

Please note that this doesn't include the PyTorch benchmark for now!

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Oct 1, 2021
@fg-mindee fg-mindee added this to the 0.4.0 milestone Oct 1, 2021
@fg-mindee fg-mindee self-assigned this Oct 1, 2021
@codecov
Copy link

codecov bot commented Oct 1, 2021

Codecov Report

Merging #519 (91ff01c) into main (fa26b7a) will decrease coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #519      +/-   ##
==========================================
- Coverage   95.40%   95.36%   -0.05%     
==========================================
  Files         109      109              
  Lines        4183     4183              
==========================================
- Hits         3991     3989       -2     
- Misses        192      194       +2     
Flag Coverage Δ
unittests 95.36% <ø> (-0.05%) ⬇️

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

Impacted Files Coverage Δ
doctr/models/detection/zoo.py 100.00% <ø> (ø)
doctr/models/recognition/master/tensorflow.py 96.47% <ø> (ø)
doctr/models/recognition/zoo.py 100.00% <ø> (ø)
doctr/models/zoo.py 100.00% <ø> (ø)
doctr/models/builder.py 92.70% <0.00%> (-1.05%) ⬇️
...dels/detection/differentiable_binarization/base.py 91.19% <0.00%> (-0.63%) ⬇️

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 fa26b7a...91ff01c. Read the comment docs.

Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks!

@fg-mindee fg-mindee merged commit 51663dd into main Oct 1, 2021
@fg-mindee fg-mindee deleted the doc-update branch October 1, 2021 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants