Metadata-Version: 2.1
Name: furo
Version: 2020.10.15b13
Summary: A clean customisable Sphinx documentation theme.
Home-page: UNKNOWN
Author: Pradyun Gedam
Author-email: mail@pradyunsg.me
License: UNKNOWN
Project-URL: homepage, https://github.com/pradyunsg/furo
Description: .. role:: raw-html-m2r(raw)
           :format: html
        
        
        :raw-html-m2r:`<h1 align="center">Furo</h1>`
        
        :raw-html-m2r:`<p align="center">
          A clean customizable theme for <a href="https://www.sphinx-doc.org/">Sphinx</a>.
        </p>`
        :raw-html-m2r:`<a href="https://pradyunsg.me/furo/">
          <img align="center" src="https://github.com/pradyunsg/furo/raw/main/docs/_static/demo.png" alt="Demo image">
        </a>`
        
        Quickstart
        ----------
        
        Furo can be installed using ``pip``\ :
        
        .. code-block::
        
           pip install furo
        
        Update the ``html_theme`` in ``conf.py``\ :
        
        .. code-block:: py
        
           html_theme = "furo"
        
        Your Sphinx documentation will now be generated with this theme! For more information, visit `Furo's documentation <https://pradyunsg.me/furo/>`_.
        
        Contributing
        ------------
        
        Furo is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our `Contributing Guide <https://pradyunsg.me/furo/contributing/>`_ for more information.
        
        Acknowledgements
        ----------------
        
        Furo is inspired by (and borrows elements from) some excellent technical documentation themes:
        
        
        * `mkdocs-material <https://squidfunk.github.io/mkdocs-material/>`_ for MkDocs
        * `Just the Docs <https://pmarsceill.github.io/just-the-docs/>`_ for Jekyll
        * `GitBook <https://www.gitbook.com/>`_
        
        We use `BrowserStack <https://browserstack.com/>`_ to test on real devices and browsers. Shoutout to them for supporting OSS projects!
        
        License
        -------
        
        This project is licensed under the MIT License.
        
Platform: UNKNOWN
Requires-Python: >=3.5
Provides-Extra: doc
Provides-Extra: test
