Sphinx Business Theme

Theme for Sphinx to create PDF files with a professional design. This theme uses Weasyprint to generate the output to PDF. A demo PDF is available.

Installation

Install the latest version from Pypi (you need previously installed pip):

pip3 install -U sphinx-business-theme

You can also install the latest version from Github:

pip3 install https://github.com/Nekmo/sphinx-business-theme/releases/latest/download/business_theme-0.1.0.tar.gz#egg=business_theme

Only Python 3+ is supported Currently only tested on unix systems. The command must be executed in a terminal. More info in the web documentation (or in the pdf documentation).

Create documentation

A Cookicutter template is included to easily create new documentation. Execute in a terminal:

$ create-docs

This command creates a new documentation directory. Go to the directory and run make pdf (only for unix) to create a pdf:

$ cd <documentation folder>
$ make pdf

However, the pdf starts without content. Write your document by editing the files index.rst and readme.rst. The syntax of the files is RestructuredText (rst). The syntax documentation is on the Sphinx website.

Read the docs on the web (or in pdf).

Demo project

You can play updating content inside demo/ dir and making the pdf again as:

cd demo/
make pdf

Upload PDF to Google Drive

Set up Google Drive to keep renderer PDF in sync. Follow the steps below:

1. Enable Drive API y download credentials.json by pressing "Enable the Drive API" button.
2. Run mkdir -p ~/.config/google-drive/ and copy credentials.json inside google-drive/ folder.

#. Get folder id from Google Drive url. For example: https://drive.google .com/drive/u/0/folders/1C1FrHclpyNtIX0xVXzlnVxxxxxx #. Put this id in the cookiecutter wizard or Makefile file (DRIVE_FOLDER variable).