ashk-sphinx-theme 1.1.10

Read the Docs theme for Sphinx

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"

Development:

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

Releasing the theme

for release the theme use:

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