search

MicheleCotrufo / pdf2doi

A python library/command-line tool to extract the DOI or other identifiers of a scientific paper from a pdf file.
101 stars 18 forks source link

Started development of documentation via sphinx #33

Closed AlessandroCotrufo closed 4 months ago

AlessandroCotrufo commented 4 months ago

I set up docs structure to generate documentation via sphinx. To generate the documentation you need to run

pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme sphinx-build -b html docs docs/_build

I did not commit the actual documentation. You can find attached it to this pull request _build.zip

I only create a doc file for the main module, and I had to fix the docstrings to accomodate it. Please tell me if you like the structure and if you want docs for all modules or you think it's not needed

AlessandroCotrufo commented 4 months ago

I forgot to make this pull request about docs independent from the other one about tests. Instead the commits are just one after the other. My bad. The changes regarding the addition of docs have to do only with the addition of files in docs, and with the edit of docstrings in main.py. All other edits have to do with the other pull request.

AlessandroCotrufo commented 4 months ago

Made a cleaner version of the PR