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] Add examples to documentation #74

Merged
merged 14 commits into from
May 12, 2020
Merged

[docs] Add examples to documentation #74

merged 14 commits into from
May 12, 2020

Conversation

jstockwin
Copy link
Owner

@jstockwin jstockwin commented May 4, 2020

Closes #48, and as a side effect closes #56.

I've temporarily published the version of the docs from this branch, to help with the review. You can view this here: https://py-pdf-parser.readthedocs.io/en/doc-examples/

  • Check docs build correctly in CI
  • Make docs nicer to edit locally (livereload etc)
  • Add changelog to docs
  • Add examples:
    • Simple example
    • More complicated example
    • Table extraction
    • Complicated table extraction (page breaks, non-simple)
    • Example with sections
    • Example which shows visualise tool in detail
  • Add tests to ensure examples always work (and hopefully helps to keep them up to date)
  • Update the overview page

@jstockwin jstockwin force-pushed the doc-examples branch 4 times, most recently from c5ff067 to f3f2db7 Compare May 5, 2020 11:14
@jstockwin jstockwin marked this pull request as ready for review May 11, 2020 13:33
Copy link

@pauloAmaral pauloAmaral left a comment

Choose a reason for hiding this comment

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

Very nice examples! I have a few comments but nothing big.

Also, do you think it would be too much to add a few screenshots of the PDFs in the first and second examples? I think it would help to understand what you're reading if you see the elements you are trying to extract data from (1st example) and creating the sections (2nd example) without having to go back and forth from docs and PDF. But no big deal, up to you!

docs/source/examples/simple_memo.rst Outdated Show resolved Hide resolved
docs/source/examples/order_summary.rst Outdated Show resolved Hide resolved
docs/source/examples/more_tables.rst Outdated Show resolved Hide resolved
docs/source/examples/more_tables.rst Outdated Show resolved Hide resolved
docs/source/examples/more_tables.rst Outdated Show resolved Hide resolved
docs/source/examples/more_tables.rst Outdated Show resolved Hide resolved
Copy link

@pauloAmaral pauloAmaral left a comment

Choose a reason for hiding this comment

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

Awesome 🥳 🥳 🥳

@jstockwin jstockwin merged commit ac983d5 into master May 12, 2020
@jstockwin jstockwin deleted the doc-examples branch May 12, 2020 09:53
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.

[tests] Create some tests which use real PDFs Add some examples to the documentation
2 participants