committing python_package.rst to repo to fix problems on readthedocs …

…(which doesnt run make html to build the documentation). fixes deanmalmgren#11.

.gitignore

@@ -51,7 +51,6 @@ coverage.xml
 # Sphinx documentation
 docs/build/
 docs/textract/
-docs/python_package.rst
 
 # vagrant
 .vagrant

docs/Makefile

@@ -54,11 +54,7 @@ clean:
 
 apidoc:
 	$(APIDOC) --force --no-toc ../textract --output-dir=./textract $(APIDOC_IGNORE)
-	@echo ".. _python-package:" > python_package.rst
-	@echo "" >> python_package.rst
-	@echo "Python package" >> python_package.rst
-	@echo "==============" >> python_package.rst
-	@echo "" >> python_package.rst
+	@cat python_package > python_package.rst
 	@grep -A8 " module" textract/textract.parsers.rst >> python_package.rst
 	@echo "" >> python_package.rst
 	@grep -A8 " module" textract/textract.rst >> python_package.rst

docs/python_package

@@ -0,0 +1,19 @@
+.. _python-package:
+
+Python package
+==============
+
+This package is organized to make it as easy as possible to add new
+extensions and support the continued growth and coverage of
+textract. For almost all applications, you will just have to do
+something like this::
+
+    import textract
+    text = textract.process('path/to/file.extension')
+
+to obtain text from a document.
+
+For completeness, we also include here the documentation for specific
+file extension parsers as well as a few other essential bits in the
+``textract.exceptions`` and ``textract.shell`` module.
+

docs/python_package.rst

@@ -0,0 +1,102 @@
+.. _python-package:
+
+Python package
+==============
+
+This package is organized to make it as easy as possible to add new
+extensions and support the continued growth and coverage of
+textract. For almost all applications, you will just have to do
+something like this::
+
+    import textract
+    text = textract.process('path/to/file.extension')
+
+to obtain text from a document.
+
+For completeness, we also include here the documentation for specific
+file extension parsers as well as a few other essential bits in the
+``textract.exceptions`` and ``textract.shell`` module.
+
+textract.parsers.doc_parser module
+----------------------------------
+
+.. automodule:: textract.parsers.doc_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.docx_parser module
+-----------------------------------
+
+.. automodule:: textract.parsers.docx_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.eml_parser module
+----------------------------------
+
+.. automodule:: textract.parsers.eml_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.html_parser module
+-----------------------------------
+
+.. automodule:: textract.parsers.html_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.json_parser module
+-----------------------------------
+
+.. automodule:: textract.parsers.json_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.pdf_parser module
+----------------------------------
+
+.. automodule:: textract.parsers.pdf_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.pptx_parser module
+-----------------------------------
+
+.. automodule:: textract.parsers.pptx_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.parsers.txt_parser module
+----------------------------------
+
+.. automodule:: textract.parsers.txt_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+
+textract.exceptions module
+--------------------------
+
+.. automodule:: textract.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+textract.shell module
+---------------------
+
+.. automodule:: textract.shell
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+