.. aparts documentation master file, created by
   sphinx-quickstart on Fri May 12 02:05:57 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

aparts
==================================
.. image:: /images/graph_view.png

Automated workflow to generate a tailored set of keywords and index academic articles. Designed to be used in combination with reference editors, and markdown-based personal knowledge management systems like obsidian and notion.

Provides direct documentation of each function (in the pythonic sense of the word) included in the package.


.. toctree::
   :maxdepth: 2
   :caption: Function overview
   :titlesonly:
   :includehidden:

   modules

Provides an overview of the documentation for all submodules.

.. toctree::
   :maxdepth: 2
   :caption: Function overview
   :titlesonly:
   :includehidden:

   Function_overview/collecting_article_records
   Function_overview/construct_keyword_list
   Function_overview/tag_papers
   Function_overview/generate_output
   Function_overview/supporting_functions

Provides an overview based on the functions their use and as such gives information on alternatives to the standard workflow. 


.. toctree::
   :maxdepth: 2
   :caption: Guidelines
   :titlesonly:
   :includehidden:

   guidelines/getting_started
   guidelines/workflow

Provides an overview of how to setup the prerequisits and run a basic workflow using the aparts library.


.. toctree::
   :maxdepth: 2
   :caption: support
   :includehidden:

   links
   frequently_wondered_inqueries

Provides liunks to the github repo, zenodo doi, and frequently asked questions.