Metadata-Version: 1.1
Name: sphinx-quickstart-plus
Version: 0.6
Summary: sphinx-quickstart Utility
Home-page: https://github.com/pashango2/sphinx-qsp
Author: Toshiyuki Ishii
Author-email: pashango2@gmail.com
License: Free
Description: sphinx-quickstart-plus

        ======================

        

        This is a utility tool that extends 'sphinx-quickstart'.

        

        Licence

        -------

        

        This module is license free :)

        

        Installation

        ------------

        

        ::

        

            pip install sphinx-quickstart-plus

        

        Use

        ---

        

        ::

        

            sphinx-quickstart-plus

        

        Features

        --------

        

        -  Remember latest setting

        -  More extensions

        -  commonmark and recommonmark

        -  Read the Docs theme

        -  sphinx\_fontawesome

        -  sphinxcontrib-blockdiag

        -  nbsphinx

        -  sphinx-autobuild

        

        Code added to ``conf.py``

        -------------------------

        

        ext\_commonmark

        ~~~~~~~~~~~~~~~

        

        .. code:: python:conf.py

        

            # ----- CommonMark

            source_suffix = [source_suffix, '.md']

        

            from recommonmark.parser import CommonMarkParser

            source_parsers = {

                '.md': CommonMarkParser,

            }

        

            from recommonmark.transform import AutoStructify

        

            github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'

            def setup(app):

                app.add_config_value('recommonmark_config', {

                        'url_resolver': lambda url: github_doc_root + url,

                        'auto_toc_tree_section': 'Contents',

                        }, True)

                app.add_transform(AutoStructify)

        

        ext\_nbshpinx

        ~~~~~~~~~~~~~

        

        .. code:: python:conf.py

        

            # ----- Jupyter Notebook nbsphinx

            extensions.append('nbsphinx')

            exclude_patterns.append('**.ipynb_checkpoints')

        

        ext\_blockdiag

        ~~~~~~~~~~~~~~

        

        .. code:: python:conf.py

        

            # ----- blockdiag settings

            extensions.extend([

                'sphinxcontrib.blockdiag',

                'sphinxcontrib.seqdiag',

                'sphinxcontrib.actdiag',

                'sphinxcontrib.nwdiag',

                'sphinxcontrib.rackdiag',

                'sphinxcontrib.packetdiag',

            ])

            blockdiag_html_image_format = 'SVG'

            seqdiag_html_image_format = 'SVG'

            actdiag_html_image_format = 'SVG'

            nwdiag_html_image_format = 'SVG'

            rackiag_html_image_format = 'SVG'

            packetdiag_html_image_format = 'SVG'

        

        ext\_fontawesome

        ~~~~~~~~~~~~~~~~

        

        .. code:: python:conf.py

        

            # ----- sphinx-fontawesome

            import sphinx_fontawesome

            extensions.append('sphinx_fontawesome')

        

        ext\_rtd\_theme

        ~~~~~~~~~~~~~~~

        

        .. code:: python:conf.py

        

            # ----- Read the Docs Theme

            html_theme = "sphinx_rtd_theme"

        

        ext\_autobuild

        ~~~~~~~~~~~~~~

        

        'auto\_build' does not override 'conf.py', but rewrites the Makefile.

        Type the following command to start auto build.

        

        ::

        

            $ make livehtml

        

        On Windows, ``auto_build.bat`` is generated, please execute it.

        

        ::

        

            $ auto_build.bat

        
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: Freeware
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Framework :: Sphinx :: Theme
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
