Skip to content

Commit

Permalink
Add instructions to build documentation (#822)
Browse files Browse the repository at this point in the history
Co-authored-by: Pieter Marsman <[email protected]>
  • Loading branch information
dmlls and pietermarsman authored Dec 29, 2023
1 parent 17a3617 commit 7715f88
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Working on documentation

The pdfminer.six docs are generated with [Sphinx](https://www.sphinx-doc.org/en/master/), using
[reStructuredText](https://docutils.sourceforge.io/rst.html).

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

## Deploying new documentation

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

## Building documentation locally

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

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

```console
python -m venv .venv
source .venv/bin/activate
```
2. With the virtual environment activated, install the dependencies for building the documentation.

```console
pip install '.[docs]'
```
3. Build the documentation.

```console
make clean && make html
```

1 change: 0 additions & 1 deletion docs/requirements.txt

This file was deleted.

0 comments on commit 7715f88

Please sign in to comment.