Readme

this is a rtl theme for Sphinx. i use Read the Docs as a base.

Installation

This theme is distributed on PyPI and can be installed with pip:

$ pip install ashk-sphinx-theme

To use the theme in your Sphinx project, you will need to edit your conf.py file’s html_theme setting:

html_theme = "sphinx_rtd_theme"

for development first read configuring the theme .

tip: for upgrade and upload to pypi remember to change the version in both files: setup.cfg & setup.py

use python3.10

make a venv:

python3.10 -m venv vevn
source venv/bin/activate
pip install -e '.[dev]'

if there was a problem with installation use you may want to use this:

npm install webpack webpack-dev-server webpack-cli --save-dev
webpack-dev-server --open --config webpack.dev.js
python -m pip install build twine

npm install
npm run build
python setup.py sdist bdist_wheel

for release the theme use:

rm -rf dist/
python setup.py sdist bdist_wheel
twine upload -r pypi --verbose dist/*

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for ashk-sphinx-theme 1.1.10
File	Size	Uploaded
ashk_sphinx_theme-1.1.10.tar.gz	3.2 MB	Jan 9, 2023	Details

Table of built distributions (wheels) for ashk-sphinx-theme 1.1.10
File	Interpreter	ABI	Platform	Reset
ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl 3.3 MB Jan 9, 2023	Python 3, Python 2	none	any	Details

Total release size: 6.5 MB

Download URL	ashk_sphinx_theme-1.1.10.tar.gz
Size	3.2 MB
Tags	Source
SHA-256 checksum How to use checksums	`1e02252dce5a2a5870d36dc893b29b54f80787888e21530878afe5c1dc88bb81`
BLAKE2b-256 checksum How to use checksums	`97f69f6ff55f07820bb9474b12aaf4ba025c83fe07a4957d15536359c887d3fb`
Upload date	Jan 9, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.9`

Download URL	ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl
Size	3.3 MB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`14743284cb97982ac4c99c3db3d8420ae37b1996f2434e9ae284c817c8c9a33e`
BLAKE2b-256 checksum How to use checksums	`c7ddf32f52b8de88bef2c3387c245ebe559a804f2afec10abe34d5540bdd8c49`
Upload date	Jan 9, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.9`