camelot-dev / camelot

A Python library to extract tabular data from PDFs
https://camelot-py.readthedocs.io
MIT License
2.95k stars 465 forks source link

Updated documentation idea / installation screencasts #479

Open nmstoker opened 9 months ago

nmstoker commented 9 months ago

Hello Camelot users / devs! I hope you're all off to a good start for the year.

For far too long I've been meaning to look at the Camelot docs to see if I could contribute to them and in the last few days I looked into what they would look like if ported to Mkdocs from Sphinx. I specifically tried out Material for Mkdocs.

My initial attempt is in this fork and the results can be viewed here:

http://about.nmstoker.com/camelot/

I've two main points in mind with this:

I'm mainly done with the first point and have made a start with the second.

For the second, I expect things will change over upcoming releases but right now I find that ignoring the "[base]" option and doing the steps manually with pip works better - otherwise pip can easily end up installing an older version due to some confusion around dependencies.

One idea I had to help guide people with installation is to embed platform specific asciinema style screencasts (they look like a video but embed the terminal text, so are pretty compact to include). The layout, content and a couple of recordings need further effort on my part to get it right (eg re-record at a correct screen size) but I hope you'll get the general idea from what's there already on these two pages:

Anyway, would be great to hear thoughts / feedback on this.

bosd commented 8 months ago

Thanks for this, the new docs looks very good. A nice to have was the terminal movie like a gif so it auto plays.

bosd commented 6 months ago

Hey!

As https://github.com/camelot-dev/camelot/issues/343 this repo is no longer maintained, we try to build a maintained fork at pypdf_table_extraction.

There are some attempts there to start using read-the-docs. But terminal style movie would be great addition. Feel free to contribute there.