Metadata-Version: 1.1
Name: sphinx-business-theme
Version: 0.1.0
Summary: A theme for Sphinx to generate PDF documentation
Home-page: https://github.com/Nekmo/sphinx-business-theme
Author: Nekmo
Author-email: contacto@nekmo.com
License: MIT
Description: .. 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. Use Weasyprint to generate the PDF file.
        `Download example <https://github.com/Nekmo/sphinx-business-theme/releases/download/v0.0.0/Sphinx.Business.Theme.pdf>`_.
        
        Installation
        ============
        Install the latest version from the source code using (you need previously `installed pip <https://pip.pypa
        .io/en/stable/installing/>`_). Only `Python 3+ is supported <https://realpython.com/installing-python/>`_::
        
           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 <https://github.com/cookiecutter/cookiecutter>`_ 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 <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
        
        Demo project
        ============
        
        You can play updating content inside `docs/demo` dir and making the pdf again as:
        
        ::
        
           cd docs/demo
           make pdf
        
Platform: UNKNOWN
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
