Skip to main content

A theme for Sphinx to generate PDF documentation

Project description

https://raw.githubusercontent.com/Nekmo/sphinx-business-theme/master/logo.png

Latest Travis CI build status

Sphinx Business Theme

Theme for Sphinx to create PDF files with a professional design. Use Weasyprint to generate the PDF file. Download example.

Installation

Install the latest version from the source code using (you need previously installed pip). Only Python 3+ is supported:

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

Currently only tested on unix systems. The command must be executed in a terminal.

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.

Demo project

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

cd docs/demo
make pdf

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-business-theme-0.1.0.tar.gz (3.4 MB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page