A simple Sphinx theme with RTL language support.
Project description
Minoo Theme is a Sphinx theme that supports right-to-left languages like Persian. It is available on PyPI and enables developers to create documentation websites with an elegant and functional design that works well with RTL languages.
Features
Material Colors
RTL language support
Responsive design
Google Analytics integration
Social links and avatar
Free to use
Installation
Via package
You can install Minoo Theme from PyPI:
$ pip install sphinx_minoo_theme
To use the theme in your Sphinx project, edit your Sphinx configuration file conf.py as follows:
# 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()]
Via git or download
Alternatively, you can download the theme from the repository and copy sphinx_minoo_theme/sphinx_minoo_theme into your documentation at _templates folder. Then, add the following lines to your conf.py file:
extensions = ["sphinxcontrib.jquery"] html_theme = "sphinx_minoo_theme" html_theme_path = ["_templates"]
Customisation
To customize the Minoo Theme, follow these steps:
Put your avatar image file into the static folder with the name avatar.jpg.
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.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_minoo_theme-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46d3779a9efeb199c4af68bac2cb142f025a57c5debdc1841242d9bc7873c843 |
|
MD5 | d3831c6fcb7c419b94b2d9e87bc52d2c |
|
BLAKE2b-256 | bd102c691f54091b68e150ddd1b960108aafb741f89642cd3abca310929b2ea1 |