Metadata-Version: 2.1
Name: sphinx-press-theme
Version: 0.7.3
Summary: A Sphinx-doc theme based on Vuepress
Home-page: https://schettino72.github.io/sphinx_press_site/
Author: Eduardo Naufel Schettino <schetino72>
License: MIT
Project-URL: Documentation, https://schettino72.github.io/sphinx_press_site/
Project-URL: Source, https://github.com/schettino72/sphinx_press_theme
Project-URL: Tracker, https://schettino72.github.io/sphinx_press_site/issues
Description: # sphinx_press_theme
        
        
        [![PyPI](https://img.shields.io/pypi/v/sphinx_press_theme.svg)](https://pypi.python.org/pypi/sphinx_press_theme)
        
        Please help me keep this project alive [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A23ZL4A)
        
        
        A modern responsive theme for python's [Sphinx](http://www.sphinx-doc.org) documentation generator.
        
        See it in action on Press Theme own [website](https://schettino72.github.io/sphinx_press_site/)
        
        
        This theme is based on [VuePress](https://vuepress.vuejs.org/).
        It uses [Vue.js](https://vuejs.org/) & [Stylus](http://stylus-lang.com/) managed by
        [vite](http://vitejs.dev/).
        
        
        
        **Press** theme is still in **BETA**.
        Contributions are welcome.
        
        ## Install
        
        First install the theme:
        
        ```
        $ pip install sphinx_press_theme
        ```
        
        Sphinx version compatibility
        
        |Sphinx |Press Theme|
        |-------|-----------|
        |4.X    | latest    |
        |3.X    | 0.6.1     |
        |2.X    | 0.5.1     |
        
        
        ## Usage
        
        On Sphinx project's ``conf.py``: set the theme name to ``press``.
        
        ```
        html_theme = "press"
        ```
        
        See details on [configuration](https://schettino72.github.io/sphinx_press_site/configuration.html).
        
        
        ## Development
        
        First build web assets:
        
        ```
        cd ui
        yarn build
        ```
        
        Sphinx theme has a soft link to built assets...
        Install theme locally with `pip install -e .`.
        
        `docs` folder contains theme's own documentantion.
        
        ```
        cd docs
        make clean html
        ```
        
        ## Release
        
        Set version on:
        
        - `setup.py`
        - `sphinx_press_theme/__init__.py`
        - `sphinx_press_theme/theme.conf`
        - `docs/source/conf.py`
        
        
        ## Website
        
        To update website:
        
        ```
        cd ../press_site
        rsync -rvi ../sphinx_press_theme/docs/build/html/ .
        git add --all
        ```
        
Keywords: sphinx doc theme vue.js
Platform: UNKNOWN
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/markdown
