Added some documentation
This commit is contained in:
36
docs/requirements.rst
Normal file
36
docs/requirements.rst
Normal file
@@ -0,0 +1,36 @@
|
||||
.. _requirements:
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
You need a Linux machine or Unix-like setup (theoretically an Apple machine
|
||||
should work) that has the following software installed on it:
|
||||
|
||||
* Python3 (with development libraries, pip and virtualenv)
|
||||
* Tesseract
|
||||
* Imagemagick
|
||||
|
||||
If you're not working on a virtual environment (like Vagrant or Docker), you
|
||||
should probably be using a virtualenv, but that's your call. The reasons why
|
||||
you might choose a virtualenv or not aren't really within the sope of this
|
||||
document.
|
||||
|
||||
In addition to the above, there are a number of Python requirements, all of
|
||||
which are listed in ``requirements.txt``. They will be installed automatically
|
||||
with ``pip`` as part of the installation process.
|
||||
|
||||
|
||||
.. _requirements-documentation:
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
As generation of the documentation is not required for use of *Paperless*,
|
||||
dependencies for this process are not included in ``requirements.txt``. If
|
||||
you'd like to generate your own docs locally, you'll need to:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ pip install sphinx
|
||||
|
||||
and then cd into the ``docs`` directory and type ``make html``.
|
||||
Reference in New Issue
Block a user