Read the Docs theme for Sphinx
Project description
This is a fork of the official Read the Docs theme for Sphinx. See their theme documentation for more information.
Installation
This theme is distributed on PyPI and can be installed with pip:
$ pip install sphinx_veldus_theme
To use the theme in your Sphinx project, you will need to add the following to your conf.py file:
import sphinx_veldus_theme
extensions = [
...
"sphinx_veldus_theme",
]
html_theme = "sphinx_veldus_theme"
For more information read the full documentation on installing the theme
Configuration
This theme is highly customizable on both the page level and on a global level. To see all the possible configuration options, read the documentation on configuring the theme.
Modifying the theme
The styles for this theme use SASS and a custom CSS framework called Wyrm. We use Webpack and node-sass to build the CSS. Webpack is used to watch for changes, rebuild the static assets, and rebuild the Sphinx demo documentation.
Set up your environment
Making changes
Changes to the theme can be compiled and tested with Webpack:
$ npm run dev
This script will do the following:
Install and update any dependencies.
Build the static CSS from SASS source files.
Build the demo documentation.
Watch for changes to the SASS files and documentation and rebuild everything on any detected changes.
Updating PyPI
After making an update to the project, you need to build, package, then update PyPI with the new updates.
Build
Run the release build script:
$ npm run build
Package the build
Find more information about packaging at the Python Packaging User Guide.
$ python3 setup.py sdist bdist_wheel
Uploading
Use Twine to upload the new package to PyPi:
$ python3 -m twine upload 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
Built Distribution
Hashes for sphinx-veldus-theme-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2f56bdfbccfe6b8b17565e404c5bc387444de624d2cdec1d31e986873c221e9 |
|
MD5 | 8b6482bfcb44ccee1e6ca92fc4588854 |
|
BLAKE2b-256 | f992c7ccd6530eacb3d7a595fcc8630aff5c941b58bbd3377f09cf4966fa7ee0 |
Hashes for sphinx_veldus_theme-0.0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bac15042d6235c89d14b717b6f2ea29a0a2ab11df68dc890106242c4ca15368 |
|
MD5 | ca653dc225b8de191361b3e59178b340 |
|
BLAKE2b-256 | d668a8b2a9699edbd0b00f679bad9e04f2a08ef847c0f99713ef7144fd2e9c83 |