Read the Docs theme for Sphinx
Project description
this is a rtl theme for Sphinx. i use Read the Docs as a base. and change it .
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/*
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
Close
Hashes for ashk_sphinx_theme-1.1.9-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c318e56e3b5ebffcc5ebac88d99f3e9eaf85797a02cde1a04b48bd19ca8681f |
|
MD5 | ab781e6f2f43f6f9358823126255dc99 |
|
BLAKE2b-256 | a8228828fdbee8784c568fba3d96608265355506499621062529f78aaf0cf652 |