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
Installing from PyPI:
$ pip install sphinx_minoo_theme
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
Copy sphinx_minoo_theme/sphinx_minoo_theme from repository into your documentation at _templates folder.
Edit the Sphinx configuration file conf.py
# ... html_theme = "sphinx_minoo_theme" html_theme_path = ["_templates"]
Customisation
Put your avatar image file into static folder with avatar.jpg name.
Edit the theme configuration file theme.conf
Change direction:
direction = ltr
for “right-to-left” languages set on 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 bitbucket =
Whichever you don’t want, left empty!
Edit the glossary.html file
In this way, you can change the theme words!
License
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.
Source Distribution
Hashes for sphinx_minoo_theme-0.9.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dff51da1cb4881dbc677ec77c1baa1cf6b36e5436a17507b2456d6d52d3e61e8 |
|
MD5 | 11cffa29c6928b282a0c3fb806a477cf |
|
BLAKE2b-256 | f72628799864597edfb00c4309eb91ffb387e6011912f2b240dc408c7159a23e |