Installation¶

Python Version¶

We recommend using the latest version of Python. Sphinx-PDF Generate supports Python 3.7 and newer.

Virtual environments¶

Use a virtual environment to manage the dependencies for your project, both in development and production.

Python comes bundled with the venv module to create virtual environments.

Create an environment¶

Create a project folder and a venv folder within:

macOS/Linux

$ mkdir myproject
$ cd myproject
$ python3 -m venv .venv

Windows (PowerShell)

> mkdir myproject
> cd myproject
> python -m venv .venv

Activate the environment¶

Before you work on your project, activate the corresponding environment:

macOS/Linux

$ .venv/bin/activate

Windows (PowerShell)

> .venv\Scripts\activate

Install Sphinx-PDF Generate¶

Within the activated environment, use the following command to install Sphinx-PDF Generate:

Using pip

$ pip install sphinx-pdf-generate

From source

$ git clone https://github.com/iSOLveIT/sphinx-pdf-generate
$ cd sphinx-pdf-generate
$ pip install .

Activate Sphinx-PDF Generate¶

Add sphinx_pdf_generate to the extensions list.

extensions = ["sphinx_pdf_generate",]

You can refer to the Quickstart page for a good introduction to Sphinx-PDF Generate.
Also, you can refer to the Options page for information about the configuration options for Sphinx-PDF Generate.