https://github.com/useblocks/groundwork-sphinx-theme

https://github.com/useblocks/groundwork-sphinx-theme

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/useblocks/groundwork-sphinx-theme
• Owner: useblocks
• License: other
• Created: 2017-06-09T09:33:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-25T05:22:38.000Z (almost 5 years ago)
• Last Synced: 2024-03-14T23:22:39.865Z (6 months ago)
• Language: Python
• Size: 274 KB
• Stars: 14
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
groundwork-sphinx-theme

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

This repository contains sphinx styles, which are use by most groundwork related projects.

It is a derivative of Kenneth Reitz's themes for his projects and of Mitsuhiko's themes for Flask and Flask related

projects.  To use this style in your Sphinx documentation, follow this guide:

1. Install the package using pip: ``pip install groundwork-sphinx-theme``

2. Add this to ``conf.py``:

   .. code-block:: python

       html_theme = 'groundwork'

Configuration

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

The groundwork-sphinx-theme provides the following configuration parameters:

 * **sidebar_width**: Allows the user to set the sidebar width in pixels. Good for deeply nested TOCs (Default: 220x)

 * **stickysidbar**: If True it makes the sidebar always visible if pages get longer (Default: True)

 * **stickysidbarscrollable**: Makes the sticky sidebar scrollable in small browser windows (Default: False)

 * **contribute**: If True, a contribute-area with github-buttons is shown inside the sidebar

 * **github_user**: Used the for github follow button. E.g.: useblocks

 * **github_fork**: Used for the github fork buttons. E.g.: useblocks/groundwork

You can change their value inside the file `conf.py` of your sphinx project::

    html_theme_options = {

        "sidebar_width": '240px',

        "stickysidebar": True,

        "stickysidebarscrollable": True,

        "contribute": True,

        "github_fork": "useblocks/groundwork",

        "github_user": "useblocks",

    }

Screenshot

----------

.. image:: screenshot.png

    :height: 400px

    :alt: screenshot of groundwork sphinx theme

    :align: center