Sphinx theme for groundwork projects (Based on flask_theme)
Project description
b’groundwork-sphinx-themen=======================nnThis repository contains sphinx styles, which are use by most groundwork related projects.nIt is a drivative of Kenneth Reitz's themes for his projects and of Mitsuhiko's themes for Flask and Flask relatednprojects. To use this style in your Sphinx documentation, follow this guide:nn1. put this folder as _themes into your docs folder. Alternativelyn you can also use git submodules to check out the contents there.nn2. add this to your conf.py::nn sys.path.append(os.path.abspath('_themes'))n html_theme_path = ['_themes']n html_theme = 'gw'nnThe following themes exist:nn**gw**n the standard groundwork documentation theme for any kind of projectsnnConfigurationn————-nThe gwTheme provides the following configuration parameters:nn * sidebar_width: Allows the user to set the sidebar width in pixels. Good for deeply nested TOCs (Default: 220x)n * stickysidbar: If True it makes the sidebar always visible if pages get longer (Default: True)n * stickysidbarscrollable: Makes the sticky sidebar scrollable in small browser windows (Default: False)n * contribute: If True, a contribute-area with github-buttons is shown inside the sidebarn * github_user: Used the for github follow button. E.g.: useblocksn * github_fork: Used for the github fork buttons. E.g.: useblocks/groundworknnYou can change their value inside the file conf.py of your sphinx project::nn html_theme_options = {n “sidebar_width”: '240px',n “stickysidebar”: True,n “stickysidebarscrollable”: True,n “contribute”: True,n “github_fork”: “useblocks/groundwork”,n “github_user”: “useblocks”,n }nnScreenshotn———-nn.. image:: screenshot.pngn :height: 400pxn :alt: screenshot of groundwork sphinx themen :align: centern’
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
Hashes for groundwork-sphinx-theme-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4801f3aa218bf2229e958718e1dea1b7a061f8e5e956028251e6cb5d3a3ef7f8 |
|
MD5 | c584cdc73a52c9d4fcf8eae3b79d04ab |
|
BLAKE2b-256 | a52a73408b2e9921fec37cb121b2004e50f1730170a66dcf4ef8f4f65ee54ba6 |