Split docs into 2 primary sections, "narrative" and "API"

This commit is contained in:
Lance Edgar 2020-02-25 14:53:53 -06:00
parent 76811ef387
commit a08808c620
3 changed files with 73 additions and 59 deletions

50
docs/api/index.rst Normal file
View file

@ -0,0 +1,50 @@
Package API
===========
This is the "raw" API documentation for the ``rattail`` package. It hopefully
contains all pertinent info regarding available functions, classes and their
attributes and method signatures etc.
.. toctree::
:maxdepth: 1
rattail
rattail/batch/handlers
rattail/batch/purchase
rattail/config
rattail/csvutil
rattail/datasync/index
rattail/datasync/consumers
rattail/db/cache
rattail/db/changes
rattail/db/model
rattail/db/model.batch
rattail/db/model.batch.labels
rattail/db/model.batch.purchase
rattail/db/model.batch.vendorcatalog
rattail/db/model.datasync
rattail/db/model.products
rattail/db/model.purchase
rattail/db/util
rattail/enum
rattail/exceptions
rattail/filemon/index
rattail/filemon/actions
rattail/filemon/config
rattail/filemon/linux
rattail/filemon/util
rattail/filemon/win32
rattail/files
rattail/importing/index
rattail/importing/handlers
rattail/importing/importers
rattail/importing/model
rattail/importing/postgresql
rattail/importing/rattail
rattail/importing/sqlalchemy
rattail/logging
rattail/mail
rattail/time
rattail/upgrades
rattail/win32

View file

@ -5,76 +5,24 @@ Rattail
Welcome to the Rattail project. Welcome to the Rattail project.
The documentation you are currently reading is for the Rattail core Python The documentation you are currently reading is for the Rattail core Python
package. Some additional information is available on the `website`_. Clearly package. Some additional information is available on the `website`_. Not
not everything is documented yet. Below you can see what has received some everything is documented yet, but we're getting there...
attention thus far.
.. _website: https://rattailproject.org/ .. _website: https://rattailproject.org/
Narrative Documentation: This documentation is split into the following primary sections:
.. toctree::
narr/importers
narr/batches
narr/receiving/index
narr/email
narr/filemon
Package API:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
api/rattail narr/index
api/rattail/batch/handlers api/index
api/rattail/batch/purchase glossary
api/rattail/config
api/rattail/csvutil
api/rattail/datasync/index
api/rattail/datasync/consumers
api/rattail/db/cache
api/rattail/db/changes
api/rattail/db/model
api/rattail/db/model.batch
api/rattail/db/model.batch.labels
api/rattail/db/model.batch.purchase
api/rattail/db/model.batch.vendorcatalog
api/rattail/db/model.datasync
api/rattail/db/model.products
api/rattail/db/model.purchase
api/rattail/db/util
api/rattail/enum
api/rattail/exceptions
api/rattail/filemon/index
api/rattail/filemon/actions
api/rattail/filemon/config
api/rattail/filemon/linux
api/rattail/filemon/util
api/rattail/filemon/win32
api/rattail/files
api/rattail/importing/index
api/rattail/importing/handlers
api/rattail/importing/importers
api/rattail/importing/model
api/rattail/importing/postgresql
api/rattail/importing/rattail
api/rattail/importing/sqlalchemy
api/rattail/logging
api/rattail/mail
api/rattail/time
api/rattail/upgrades
api/rattail/win32
Indices and tables Indices and tables
================== ==================
* :ref:`glossary`
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex`
* :ref:`search` * :ref:`search`
.. toctree::
:hidden:
glossary

16
docs/narr/index.rst Normal file
View file

@ -0,0 +1,16 @@
Narrative
=========
This section aims to collect so-called "narrative" documentation, to explain
some of the concepts and other "what/why" things with which Rattail concerns
itself.
.. toctree::
:maxdepth: 1
importers
batches
receiving/index
email
filemon