{"id":13680502,"url":"https://github.com/useblocks/groundwork-sphinx-theme","last_synced_at":"2025-12-30T03:52:50.789Z","repository":{"id":57436092,"uuid":"93842978","full_name":"useblocks/groundwork-sphinx-theme","owner":"useblocks","description":null,"archived":false,"fork":false,"pushed_at":"2019-11-25T05:22:38.000Z","size":281,"stargazers_count":14,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T22:44:16.077Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/useblocks.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-09T09:33:17.000Z","updated_at":"2023-12-14T10:48:51.000Z","dependencies_parsed_at":"2022-09-01T18:43:52.575Z","dependency_job_id":null,"html_url":"https://github.com/useblocks/groundwork-sphinx-theme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fgroundwork-sphinx-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fgroundwork-sphinx-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fgroundwork-sphinx-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useblocks%2Fgroundwork-sphinx-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/useblocks","download_url":"https://codeload.github.com/useblocks/groundwork-sphinx-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251600357,"owners_count":21615693,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T13:01:17.777Z","updated_at":"2025-12-30T03:52:50.762Z","avatar_url":"https://github.com/useblocks.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseblocks%2Fgroundwork-sphinx-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuseblocks%2Fgroundwork-sphinx-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseblocks%2Fgroundwork-sphinx-theme/lists"}