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.

Sign up for GitHub

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

Jump to bottom

docs: Updated documentation #475

Merged
merged 4 commits into from
Sep 16, 2021
Merged

docs: Updated documentation #475

merged 4 commits into from
Sep 16, 2021

Conversation

fg-mindee
Copy link
Contributor

@fg-mindee fg-mindee commented Sep 15, 2021 •
edited
Loading

As per #26, this PR introduces the following modifications to the documentation:

  • made copyright year mention dynamic
  • removed parent class documentation that isn't used by 99.99% of the users
  • improved the landing page
  • improved the installation page
  • added documentation of update methods for metrics
  • adds google analytics tag

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Sep 15, 2021
@fg-mindee fg-mindee added this to the 0.4.0 milestone Sep 15, 2021
@fg-mindee fg-mindee self-assigned this Sep 15, 2021
charlesmindee
charlesmindee approved these changes Sep 16, 2021
View reviewed changes
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!

@codecov
Copy link

codecov bot commented Sep 16, 2021

Codecov Report

Merging #475 (a4937e9) into main (cfc329f) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #475      +/-   ##
==========================================
+ Coverage   95.37%   95.39%   +0.02%     
==========================================
  Files          97       97              
  Lines        4065     4065              
==========================================
+ Hits         3877     3878       +1     
+ Misses        188      187       -1
Flag Coverage Δ
unittests 95.39% <ø> (+0.02%) ⬆️

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

Impacted Files Coverage Δ
...dels/detection/differentiable_binarization/base.py 91.97% <0.00%> (+0.61%) ⬆️

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 cfc329f...a4937e9. Read the comment docs.

@fg-mindee fg-mindee merged commit e134da4 into main Sep 16, 2021
@fg-mindee fg-mindee deleted the doc-update branch September 16, 2021 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charlesmindee charlesmindee charlesmindee approved these changes

Assignees

@fg-mindee fg-mindee

Labels
topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Milestone
0.4.0
Development

Successfully merging this pull request may close these issues.
2 participants
@fg-mindee @charlesmindee