Skip to content

Commit 1cd1bd8

Browse files
authored
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
1 parent ded60af commit 1cd1bd8

File tree

5 files changed

+374
-282
lines changed

5 files changed

+374
-282
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
</h2>
3333
<div align="center">
3434
<p>Unstructured wants to make it easier to connect to your data…and we need your help! We’re excited to announce a <a href="Competition.md">competition</a> focused on improving Unstructured's ability to seamlessly process data from the sources you care about most.</p>
35-
35+
3636
<p>The competition starts now and continues through March 10...and most importantly, we're offering cash prizes! Please join our <a
3737
href="https://join.slack.com/t/unstructuredw-kbe4326/shared_invite/zt-1nlh1ot5d-dfY7zCRlhFboZrIWLA4Qgw">
3838
community Slack</a> to participate and follow along</p>
@@ -85,6 +85,7 @@ At this point, you should be able to run the following code:
8585
from unstructured.partition.auto import partition
8686

8787
elements = partition(filename="example-docs/fake-email.eml")
88+
print("\n\n".join([str(el) for el in elements]))
8889
```
8990

9091
And if you installed with `local-inference`, you should be able to run this as well:
@@ -93,6 +94,7 @@ And if you installed with `local-inference`, you should be able to run this as w
9394
from unstructured.partition.auto import partition
9495

9596
elements = partition("example-docs/layout-parser-paper.pdf")
97+
print("\n\n".join([str(el) for el in elements]))
9698
```
9799

98100

0 commit comments

Comments
 (0)