-
Notifications
You must be signed in to change notification settings - Fork 940
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add instructions to build documentation (#822)
Co-authored-by: Pieter Marsman <[email protected]>
- Loading branch information
1 parent
17a3617
commit 7715f88
Showing
2 changed files
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
|
This file was deleted.
Oops, something went wrong.