amunra-sphinx-theme 0.2

摘要

amunra基于bootstrap 4为sphinx提供了一个轻量级、易于使用、响应性强的主题。 它具有一个最低限度的顶部导航栏，可以手动配置 或者使用sphinx的标准toctree指令。

演示

请在此处查看活动主题：

• https://barentsen.github.io/amunra-sphinx-theme/（view source）
• https://docs.lightkurve.org/（view source）

安装

1. 安装主题：

   pip install amunra-sphinx-theme
   

2. 在sphinx的conf.py配置文件中配置它 如下所示：

   html_theme = "amunra_sphinx_theme"
   

3. 通过添加以下代码段来配置主题选项 在conf.py文件中：

   html_theme_options = {
       # Title shown in the top left. (Default: ``project`` value.)
       "navbar_title": "Amunra",
   
       # Links to shown in the top bar. (Default: top-level ``toctree`` entries.)
       "navbar_links": [
           ("Quickstart", "quickstart"),
           ("Tutorials", "tutorials/index"),
           ("API", "api/index"),
           ("About", "about/index"),
       ],
   
       # If ``github_link`` is set, a GitHub icon will be shown in the top right.
       "github_link": "https://github.com/barentsen/amunra-sphinx-theme",
   
       # Text to show in the footer of every page.
       "footer_text": "Created with ♥ by Geert Barentsen.",
   
       # Google Analytics ID. (Optional.)
       "analytics_id": "UA-XXXXX-X"
   }
   

4. 可选：通过包含 在index.rst文件中执行以下代码：

   .. title:: Your-Project-Title
   
   .. container:: lead
   
       Your-Project-Title
   
       A short description of your project.
   
       .. raw:: html
   
           <a href="quickstart.html" class="btn btn-primary">Quickstart →</a>