Skip to main content

A beautiful, minimalist, and responsive theme for your Sphinx projects.

Project description

Amunra-Sphinx-Theme preview


Amunra provides a lightweight, easy-to-use, responsive theme for Sphinx based on Bootstrap 4. It features a minimalist top navigation bar which can be configured manually or using Sphinx’s standard toctree directive.


See the theme in action here:


  1. Install the theme:

    pip install amunra-sphinx-theme
  2. Configure it in your Sphinx’s configuration file as follows:

    html_theme = "amunra_sphinx_theme"
  3. Configure the theme options by adding the following snippet in your 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": "",
        # 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. Optional: create a nice splash page for your project by including the following code in your index.rst file:

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

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

amunra_sphinx_theme-0.2.tar.gz (92.9 kB view hashes)

Uploaded source

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