building the docs

.pre-commit-config.yml

@@ -0,0 +1,4 @@
+-   repo: https://github.com/pre-commit/mirrors-pytest
+    rev: v0.13.0  # Use the version you prefer
+    hooks:
+    -   id: pytest

README.md

@@ -54,7 +54,7 @@ Beyond the heavy-lifting performed behind the scenes  by ScrapeMed to standardiz
 
 ## Sponsorship
 
-Package sponsored by Daceflow.ai!
+***Package sponsored by Daceflow.ai!***
 
 If you'd like to sponsor a feature or donate to the project, reach out to me at [email protected].
 

docs/build/html/_sources/index.rst.txt

@@ -6,10 +6,21 @@
 Welcome to scrapemed's documentation!
 =====================================
 
+ScrapeMed is a powerful, easy to use, data scraping tool for PubMed Central (PMC) data. 
+Most users will only need to interact with ``Paper`` and ``paperSet`` objects to build 
+their PMC datasets, but a complete documentation of ScrapeMed's modules and functions can be found here. 
+
+Quick Start 
+===========
+
+Quick start placeholder.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   scrapemed
+   modules
 
 
 Indices and tables

docs/build/html/_sources/modules.rst.txt

@@ -0,0 +1,8 @@
+scrapemed
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   scrapemed
+   setup

docs/build/html/_sources/scrapemed.rst.txt

@@ -0,0 +1,61 @@
+scrapemed package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   scrapemed.tests
+
+Submodules
+----------
+
+scrapemed.paper module
+----------------------
+
+.. automodule:: scrapemed.paper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.paperSet module
+-------------------------
+
+.. automodule:: scrapemed.paperSet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.scrape module
+-----------------------
+
+.. automodule:: scrapemed.scrape
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.trees module
+----------------------
+
+.. automodule:: scrapemed.trees
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.utils module
+----------------------
+
+.. automodule:: scrapemed.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: scrapemed
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/scrapemed.tests.rst.txt

@@ -0,0 +1,101 @@
+scrapemed.tests package
+=======================
+
+Submodules
+----------
+
+scrapemed.tests.test\_clean module
+----------------------------------
+
+.. automodule:: scrapemed.tests.test_clean
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_morehtml module
+-------------------------------------
+
+.. automodule:: scrapemed.tests.test_morehtml
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_paper module
+----------------------------------
+
+.. automodule:: scrapemed.tests.test_paper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_paperSet module
+-------------------------------------
+
+.. automodule:: scrapemed.tests.test_paperSet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_parse module
+----------------------------------
+
+.. automodule:: scrapemed.tests.test_parse
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_scrape module
+-----------------------------------
+
+.. automodule:: scrapemed.tests.test_scrape
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_setup module
+----------------------------------
+
+.. automodule:: scrapemed.tests.test_setup
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_text module
+---------------------------------
+
+.. automodule:: scrapemed.tests.test_text
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_trees module
+----------------------------------
+
+.. automodule:: scrapemed.tests.test_trees
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_utils module
+----------------------------------
+
+.. automodule:: scrapemed.tests.test_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scrapemed.tests.test\_validate module
+-------------------------------------
+
+.. automodule:: scrapemed.tests.test_validate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: scrapemed.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/setup.rst.txt

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance: