https://github.com/nekmo/sphinx-business-theme
Sphinx theme to generate PDF files using Weasyprint
https://github.com/nekmo/sphinx-business-theme
Last synced: 10 months ago
JSON representation
Sphinx theme to generate PDF files using Weasyprint
- Host: GitHub
- URL: https://github.com/nekmo/sphinx-business-theme
- Owner: Nekmo
- License: mit
- Created: 2019-10-18T18:54:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-21T22:35:05.000Z (almost 3 years ago)
- Last Synced: 2025-09-20T12:26:44.556Z (10 months ago)
- Language: SCSS
- Homepage:
- Size: 3.88 MB
- Stars: 33
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE.txt
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
.. image:: https://raw.githubusercontent.com/Nekmo/sphinx-business-theme/master/logo.png
:width: 100%
|
.. image:: https://img.shields.io/travis/Nekmo/sphinx-business-theme.svg?style=flat-square&maxAge=2592000
:target: https://travis-ci.org/Nekmo/sphinx-business-theme
:alt: Latest Travis CI build status
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
$ 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:
#. Enable Drive API y download `credentials.json `_
by pressing "Enable the Drive API" button.
#. 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).