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: Added links to tutorial notebooks in the documentation #619

Merged
merged 3 commits into from
Nov 15, 2021

Conversation

fg-mindee
Copy link
Contributor

This PR introduces the following modifications:

  • adds a notebooks folder that will reference all notebooks to be displayed in the documentation
  • added a symlink in sphinx documentation to use this README to generate an identical page in the documentation
  • added corresponding sphinx deps to handle tables

Here is how the corresponding documentation page renders:
image

Closes #558

Any feedback is welcome!

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

codecov bot commented Nov 12, 2021

Codecov Report

Merging #619 (43c2845) into main (3a26c94) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #619   +/-   ##
=======================================
  Coverage   96.18%   96.18%           
=======================================
  Files         111      111           
  Lines        4296     4300    +4     
=======================================
+ Hits         4132     4136    +4     
  Misses        164      164           
Flag Coverage Δ
unittests 96.18% <ø> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
doctr/datasets/doc_artefacts.py 94.11% <0.00%> (+0.78%) ⬆️

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 3a26c94...43c2845. Read the comment docs.

@felixdittrich92
Copy link
Contributor

felixdittrich92 commented Nov 12, 2021

Looks great 👍
But can you add the .render() method also in your example notebook ? :)

@fg-mindee
Copy link
Contributor Author

Looks great +1 But can you add the .render() method also in your example notebook ? :)

Thanks for the suggestion, I plan on making a notebook about Document elements, and I intended to keep that for this purpose to avoid throwing to much information for a "quick tour" ;)

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 2a4e2b4 into main Nov 15, 2021
@fg-mindee fg-mindee deleted the colab-notebooks branch November 15, 2021 14:39
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.

How to run this github repo on google colab
3 participants