sphinx_minoo_theme 1.2.0

Features

• Material Colors

• RTL language support

• Responsive design

• Google Analytics integration

• Social links and avatar

• Free to use

Installation

$ pip install sphinx_minoo_theme

# At the top.
import sphinx_minoo_theme

# ...

extensions = ["sphinxcontrib.jquery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = [sphinx_minoo_theme.get_html_theme_path()]

extensions = ["sphinxcontrib.jquery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = ["_templates"]

Customisation

To customize the Minoo Theme, follow these steps:

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

2. Edit the theme configuration file theme.conf:

• Change direction:

  direction = ltr

  For “right-to-left” languages, set it to rtl

• Add your Google Analytics ID:

  analytics_id = UA-XXXXX-X

• Add your website address and social links:

  website =
  facebook =
  googleplus =
  linkedin =
  twitter =
  github = https://github.com/saeiddrv/SphinxMinooTheme
  gitlab =
  bitbucket =

  Leave empty whichever you don’t want.

3. Edit the glossary.html file to change the theme words.

License

Minoo Theme is licensed under the MIT License. For more information, see the LICENSE file.

Gratitude

I would like to thank sphinx_rtd_theme for helping me build this theme.