Sphinx theme for groundwork projects (Based on flask_theme)
Project description
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:
Install the package using pip: pip install groundwork-sphinx-theme
Add this to conf.py:
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for groundwork-sphinx-theme-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1629a223293228e8b296903291fa0ccd453dc3ed163fa342826a57eec4ef69d5 |
|
MD5 | 97df49f173c2218aa76d6cd09f9fa89f |
|
BLAKE2b-256 | 254337ed5c55a084620b00dc70a9ef1a244a0016a9bcc3689e40b6a2a10634d2 |
Hashes for groundwork_sphinx_theme-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3102e624e7695386b6584d19f9f3248b3b4c6ea7b48de04201b9db4aa42c5259 |
|
MD5 | 53d3d1d3d425013fad81349533d8b75c |
|
BLAKE2b-256 | 39cf5550093b347fb758eeedc49a8ceb4d369940c20a87922acdf8045c90a9d8 |