grg-sphinx-theme

GRG项目及其相关软件包的Sphinx主题。

使用方法

安装

pip install grg-sphinx-theme

要开始使用此主题，您需要在conf.py中设置主题。

html_theme = "grg_sphinx_theme"

要更新不同的导航栏链接，请更新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
                  }
              ]
            }
        ]
     }
  ]
...
}

贡献指南

对于贡献，我们需要保持相同的编码标准和格式。我们建议使用VSCode作为编辑器，并在VSCode上使用prettier扩展。

有关更多步骤，您可以阅读我们的贡献指南