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.

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


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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file ashk_sphinx_theme-1.1.10.tar.gz.

File metadata

  • Download URL: ashk_sphinx_theme-1.1.10.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.9

File hashes

Hashes for ashk_sphinx_theme-1.1.10.tar.gz
Algorithm Hash digest
SHA256 1e02252dce5a2a5870d36dc893b29b54f80787888e21530878afe5c1dc88bb81
MD5 1e72219404a45a24c10d372a24994ca2
BLAKE2b-256 97f69f6ff55f07820bb9474b12aaf4ba025c83fe07a4957d15536359c887d3fb

See more details on using hashes here.

File details

Details for the file ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 14743284cb97982ac4c99c3db3d8420ae37b1996f2434e9ae284c817c8c9a33e
MD5 6b2cc9edb00cbe9d4d3c56eb4a2d4506
BLAKE2b-256 c7ddf32f52b8de88bef2c3387c245ebe559a804f2afec10abe34d5540bdd8c49

See more details on using hashes here.

Supported by

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