Skip to main content

Read the Docs theme for Sphinx

Project description

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


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 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 &

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
python -m pip install build twine
npm install
npm run build
python sdist bdist_wheel

Releasing the theme

for release the theme use:

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

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

ashk_sphinx_theme-1.1.10.tar.gz (3.2 MB view hashes)

Uploaded source

Built Distribution

ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl (3.3 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page