From 7715f88be78e9bea702f319949cbcb89d4c27fcd Mon Sep 17 00:00:00 2001 From: Diego Miguel Lozano <22967053+dmlls@users.noreply.github.com> Date: Fri, 29 Dec 2023 21:06:54 +0100 Subject: [PATCH] Add instructions to build documentation (#822) Co-authored-by: Pieter Marsman --- docs/README.md | 34 ++++++++++++++++++++++++++++++++++ docs/requirements.txt | 1 - 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 docs/README.md delete mode 100644 docs/requirements.txt diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..91e7ebcf --- /dev/null +++ b/docs/README.md @@ -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 + ``` + diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 1e76fdad..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -sphinx-argparse \ No newline at end of file