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 details)

Uploaded Source

Built Distribution

sphinx_business_theme-0.1.0-py3-none-any.whl (3.4 MB view details)

Uploaded Python 3

File details

Details for the file sphinx-business-theme-0.1.0.tar.gz.

File metadata

  • Download URL: sphinx-business-theme-0.1.0.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for sphinx-business-theme-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2a448d9f74e820a827bdff378ae44cfd22c50b0e30e8f5670ec679453310ea82
MD5 6a5707cd6d0e9f0c6f87953b354759c3
BLAKE2b-256 bc0ff0c957da4a93957c78add1aacaf3e8fb249613d13a3e437844a14947aff5

See more details on using hashes here.

File details

Details for the file sphinx_business_theme-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_business_theme-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for sphinx_business_theme-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c41a01b4d37d3f3e5bf64ae86ed62f08b8d3db6a441c87f545985b0145c8b625
MD5 01f1bac7172e935073cbf24258514a43
BLAKE2b-256 03dc9a96a00efbf339cfbe7bbbb8dbc545045790a9fa3f4090567a645656dda7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page