The pdfminer.six docs are generated with Sphinx, using reStructuredText.

The documentation is hosted on https://pdfminersix.readthedocs.io/.

New documentation is deployed automatically when PR's are merged.

You can build the documentation locally on your machine using the following steps.

1. (Recommended) create a and activate a Python virtual environment.

   python -m venv .venv
   source .venv/bin/activate

2. With the virtual environment activated, install the dependencies for building the documentation.

   pip install '.[docs]'

3. Build the documentation.

   make clean && make html