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:
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
1 maintainer
Metadata
1 maintainer
Release files for groundwork-sphinx-theme 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| groundwork-sphinx-theme-1.1.1.tar.gz | 26.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 53.3 kB
Release files / groundwork-sphinx-theme-1.1.1.tar.gz
| Download URL | groundwork-sphinx-theme-1.1.1.tar.gz |
|---|---|
| Size | 26.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f1217bf34daba5fcd93e8a2a04ef5a6c2b144ec43754aec7ce14de501e23fe4
|
|
BLAKE2b-256 checksum How to use checksums |
8a9d304bfacefd0ef853c48af60aee35c096dd392ef4b340d336a59a7b8c953b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.6
|
Release files / groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl
| Download URL | groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 26.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
b4796989ce3cd6d5b5a3c7ebe52a8c9cf848110e9f12c2c88e2b3c0e4e8f0e24
|
|
BLAKE2b-256 checksum How to use checksums |
6be37c1b4e2d62d89229c9df5b90f2195b36758dab8a7f00f0710a90d0f414cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.6
|
