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.

For more steps, you can read our Contributing guidelines

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.3.2.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

grg_sphinx_theme-0.3.2-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for grg_sphinx_theme-0.3.2.tar.gz
Algorithm Hash digest
SHA256 d301f1c94f779a29d69fd7a8f63ebae0c1c4afa5c458a91e07a3c2ef18723cc0
MD5 1e217d4f4eb1fc62faf2cf0dd85aa05a
BLAKE2b-256 92a9af62df23966de43b0288d37c7c10451253a86794f7c0bece529d64d7d206

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for grg_sphinx_theme-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b66e407295c0366b8e562fef3dabe7e31af4d069d6631ac52914cc8c5edead2
MD5 a3e338e4698194690b8527377f8bcd5c
BLAKE2b-256 cf8c12c05d3d5ae1170c46953246b00054aee38a26cc32cb35acef805c82cfe6

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