Skip to main content

A simple Sphinx theme with RTL language support.

Project description

https://badge.fury.io/py/sphinx_minoo_theme.svg

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.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx_minoo_theme-0.9.7.zip (833.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page