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
Raw data
{
"_id": null,
"home_page": "https://github.com/useblocks/groundwork-sphinx-theme",
"name": "groundwork-sphinx-theme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "team useblocks",
"author_email": "info@useblocks.com",
"download_url": "https://files.pythonhosted.org/packages/8a/9d/304bfacefd0ef853c48af60aee35c096dd392ef4b340d336a59a7b8c953b/groundwork-sphinx-theme-1.1.1.tar.gz",
"platform": "any",
"description": "groundwork-sphinx-theme\n=======================\n\nThis repository contains sphinx styles, which are use by most groundwork related projects.\nIt is a derivative of Kenneth Reitz's themes for his projects and of Mitsuhiko's themes for Flask and Flask related\nprojects. To use this style in your Sphinx documentation, follow this guide:\n\n1. Install the package using pip: ``pip install groundwork-sphinx-theme``\n\n2. Add this to ``conf.py``:\n\n .. code-block:: python\n\n html_theme = 'groundwork'\n\nConfiguration\n-------------\nThe groundwork-sphinx-theme provides the following configuration parameters:\n\n * **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 sidebar\n * **github_user**: Used the for github follow button. E.g.: useblocks\n * **github_fork**: Used for the github fork buttons. E.g.: useblocks/groundwork\n\nYou can change their value inside the file `conf.py` of your sphinx project::\n\n 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 }\n\nScreenshot\n----------\n\n.. image:: screenshot.png\n :height: 400px\n :alt: screenshot of groundwork sphinx theme\n :align: center\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx theme for groundwork projects (Based on flask_theme)",
"version": "1.1.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "dca3cc1a7f17c5bcdd750a3942a955f1",
"sha256": "b4796989ce3cd6d5b5a3c7ebe52a8c9cf848110e9f12c2c88e2b3c0e4e8f0e24"
},
"downloads": -1,
"filename": "groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "dca3cc1a7f17c5bcdd750a3942a955f1",
"packagetype": "bdist_wheel",
"python_version": "3.6",
"requires_python": null,
"size": 26875,
"upload_time": "2019-11-25T05:24:25",
"upload_time_iso_8601": "2019-11-25T05:24:25.253935Z",
"url": "https://files.pythonhosted.org/packages/6b/e3/7c1b4e2d62d89229c9df5b90f2195b36758dab8a7f00f0710a90d0f414cc/groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "3fcb3ddfde640d314e80b7f0e3243b05",
"sha256": "5f1217bf34daba5fcd93e8a2a04ef5a6c2b144ec43754aec7ce14de501e23fe4"
},
"downloads": -1,
"filename": "groundwork-sphinx-theme-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3fcb3ddfde640d314e80b7f0e3243b05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26423,
"upload_time": "2019-11-25T05:24:22",
"upload_time_iso_8601": "2019-11-25T05:24:22.842500Z",
"url": "https://files.pythonhosted.org/packages/8a/9d/304bfacefd0ef853c48af60aee35c096dd392ef4b340d336a59a7b8c953b/groundwork-sphinx-theme-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-11-25 05:24:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "useblocks",
"github_project": "groundwork-sphinx-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "groundwork-sphinx-theme"
}
JSON
