A beautiful, minimalist, and responsive theme for your Sphinx projects.
Project description
A minimalist theme for Sphinx based on Bootstrap.
Summary
Amunra provides a lightweight, easy-to-use, and responsive theme for Sphinx based on Bootstrap. It features a minimalist top navigation bar which can be configured manually. By default, the bar will show the top-level entries of Sphinx’s toctree directive.
Demo
See it in action at docs.lightkurve.org, and inspect that website’s source code at github.com/KeplerGO/lightkurve/tree/master/docs.
Installation
Install the theme:
pip install amunra-sphinx-theme
Configure it in your Sphinx’s conf.py configuration file as follows:
html_theme = "amunra_sphinx_theme"
Configure the theme options by adding the following snippet in your conf.py file:
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" }
Optional: create a nice splash page for your project by including the following code in your index.rst file:
.. container:: lead Your-Project-Title A short description of your project. .. raw:: html <a href="quickstart.html" class="btn btn-primary">Quickstart →</a> ----------
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.