Skip to main content

A GRG sphinx theme to use across GRG projects

Project description

grg-sphinx-theme

A Sphinx theme for GRG projects and its affiliated packages.

Usage

install

pip install grg-sphinx-theme

To start using the theme you need to set the theme in conf.py

html_theme = "grg_sphinx_theme"

To set different navbar-links update the html_theme_options

html_theme_options = {
...
  "navbar_center": ["components/navbar-links.html"],
  "navbar_links": [
     {
        "url": "#",
        "name": "Home",
     },
     {
        "name": "Community",
        "children": [
          {
            "url": "https://www.geeksforgeeks.org/python-ways-to-concatenate-two-lists/",
            "name": "GeeksForGeeks",
            "external": True
          }
        ]
     },
     {
        "name": "Multiple",
        "sections": [
            {
              "name": "First",
              "children": [
                  {
                    "name": "First-Hello",
                    "url": "",
                    "external": True
                  },
                  {
                    "name": "First-How",
                    "url": ""
                  }
              ]
            },
            {
              "name": "Second",
              "children": [
                  {
                    "name": "Second-Hello",
                    "url": ""
                  },
                  {
                    "name": "Second-How",
                    "url": "",
                    "external": True
                  }
              ]
            }
        ]
     }
  ]
...
}

Contributing Guidelines

For contribution we are required to have to maintain the same coding standard and formatting. We recommend using VSCode as an editor and use prettier extension on the VSCode.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grg_sphinx_theme-0.1.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

grg_sphinx_theme-0.1.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file grg_sphinx_theme-0.1.0.tar.gz.

File metadata

  • Download URL: grg_sphinx_theme-0.1.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for grg_sphinx_theme-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bb33354c6d87b919f57cbdb6d558983a19ce218617f6ff1d8e4beb4c601269be
MD5 0aa791adf026833f958accd8cb43deaf
BLAKE2b-256 a1c990fb91857b8d52217f1be2087643bd382c71b25d384fd30e74447a3d3079

See more details on using hashes here.

Provenance

File details

Details for the file grg_sphinx_theme-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for grg_sphinx_theme-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87a5de78d652caddc162c0a37194f48ce6b123188727344547aa5fdc7797ad22
MD5 fb4e43e893cb7e28e5a223be9434f1e9
BLAKE2b-256 a5a8b8cd2784c0b147692dfa8bba5c597a9c0c5f4889ebc556744f17e8f19055

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page