sphinx-veldus-theme

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

Install Sphinx and documentation build dependencies.
```
$ pip install -e '.[dev]'
```
Install Webpack, node-sass, and theme dependencies locally.
```
$ npm install
```

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/*

Metadata

Release files for sphinx-veldus-theme 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-veldus-theme 0.0.5
File	Size	Uploaded	Provenance
sphinx-veldus-theme-0.0.5.tar.gz	2.8 MB	Oct 22, 2020	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-veldus-theme 0.0.5
File	Interpreter	ABI	Platform	Reset
sphinx_veldus_theme-0.0.5-py2.py3-none-any.whl 2.8 MB Oct 22, 2020 Without provenance	Python 2, Python 3	none	any	Details

Total release size: 5.6 MB

Release files / sphinx-veldus-theme-0.0.5.tar.gz

Download URL	sphinx-veldus-theme-0.0.5.tar.gz
Size	2.8 MB
Tags	Source
SHA-256 checksum How to use checksums	`e2f56bdfbccfe6b8b17565e404c5bc387444de624d2cdec1d31e986873c221e9`
BLAKE2b-256 checksum How to use checksums	`f992c7ccd6530eacb3d7a595fcc8630aff5c941b58bbd3377f09cf4966fa7ee0`
Upload date	Oct 22, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.9`

Release files / sphinx_veldus_theme-0.0.5-py2.py3-none-any.whl

Download URL	sphinx_veldus_theme-0.0.5-py2.py3-none-any.whl
Size	2.8 MB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`7bac15042d6235c89d14b717b6f2ea29a0a2ab11df68dc890106242c4ca15368`
BLAKE2b-256 checksum How to use checksums	`d668a8b2a9699edbd0b00f679bad9e04f2a08ef847c0f99713ef7144fd2e9c83`
Upload date	Oct 22, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.9`

Security for sphinx-veldus-theme 0.0.5

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.