Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A simple Sphinx theme with RTL language support.

Project Description

Minoo is a simple Sphinx theme with supports right-to-left languages such as Persian.

Features

  • Material Colors
  • RTL language
  • Responsive
  • Google Analytics id
  • Social Links and Avatar
  • Free

Installation

Via package

  1. Installing from PyPI:

    $ pip install sphinx_minoo_theme
    
  2. Edit the Sphinx configuration file conf.py

    # At the top.
    import sphinx_minoo_theme
    
    # ...
    
    html_theme = "sphinx_minoo_theme"
    
    html_theme_path = [sphinx_minoo_theme.get_html_theme_path()]
    

Via git or download

  1. Copy sphinx_minoo_theme/sphinx_minoo_theme from repository into your documentation at _templates folder.

  2. Edit the Sphinx configuration file conf.py

    # ...
    
    html_theme = "sphinx_minoo_theme"
    
    html_theme_path = ["_templates"]
    

Customisation

  1. Put your avatar image file into static folder with avatar.jpg name.

Edit the theme configuration file theme.conf

  1. Change direction:

    direction = ltr
    
for “right-to-left” languages set on rtl
  1. Add your Google Analytics id:

    analytics_id = UA-XXXXX-X
    
  2. Add your website address and social links:

    website =
    facebook =
    googleplus =
    linkedin =
    twitter =
    github = https://github.com/saeiddrv/SphinxMinooTheme
    bitbucket =
    
Whichever you don’t want, left empty!

Edit the glossary.html file

  1. In this way, you can change the theme words!

Gratitude

sphinx_rtd_theme helped me build this theme.

Release History

Release History

This version
History Node

0.9.7

History Node

0.9.6

History Node

0.9.5

History Node

0.9.4

History Node

0.9.3.1

History Node

0.9.3

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinx_minoo_theme-0.9.7.zip (833.4 kB) Copy SHA256 Checksum SHA256 Source Sep 20, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting