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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file groundwork-sphinx-theme-1.1.1.tar.gz.
File metadata
- Download URL: groundwork-sphinx-theme-1.1.1.tar.gz
- Upload date:
- Size: 26.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f1217bf34daba5fcd93e8a2a04ef5a6c2b144ec43754aec7ce14de501e23fe4
|
|
| MD5 |
3fcb3ddfde640d314e80b7f0e3243b05
|
|
| BLAKE2b-256 |
8a9d304bfacefd0ef853c48af60aee35c096dd392ef4b340d336a59a7b8c953b
|
File details
Details for the file groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl.
File metadata
- Download URL: groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 26.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4796989ce3cd6d5b5a3c7ebe52a8c9cf848110e9f12c2c88e2b3c0e4e8f0e24
|
|
| MD5 |
dca3cc1a7f17c5bcdd750a3942a955f1
|
|
| BLAKE2b-256 |
6be37c1b4e2d62d89229c9df5b90f2195b36758dab8a7f00f0710a90d0f414cc
|
