Matt Robinson 1cd1bd8eba
docs: more detailed bricks writeup; reoganize docs (#304)
* add print statement in readme

* elements before bricks

* new preamble to bricks section

* add preamble to bricks section

* add preamble to cleaning section

* descriptions of each documentation page

* non-brick helper functions to the bottom

* fix codeblock

* includes some optional kwargs

* code blocks

* typo fix
2023-02-27 23:11:49 +00:00

35 lines
897 B
ReStructuredText

Document Parsing
================
The ``unstructured`` library is designed to help preprocess structure unstructured text documents
for use in downstream machine learning tasks. Examples of documents that can be processes
using the ``unstructured`` library include PDFs, XML and HTML documents.
Library Documentation
---------------------
:doc:`installing`
Instructions on how to install the ``unstructured`` library on your system.
:doc:`getting_started`
Check out this section to learn about basic workflows in ``unstructured``.
:doc:`bricks`
Learning more about partitioning, cleaning, and staging bricks, included advanced usage patterns.
:doc:`examples`
Examples of other types of workflows within the ``unstructured`` package.
.. Hidden TOCs
.. toctree::
:caption: Library Documentation
:maxdepth: 2
:hidden:
installing
getting_started
bricks
examples