TiaC Systems Network (TSN) theme for Sphinx
Project description
This repository contains the Sphinx theme for TiaC Systems Network (TSN) documentation, based on Read The Docs’ default theme (sphinx_rtd_theme). This theme was forked from the Nordic Semiconductor NCS theme for Sphinx (sphinx-ncs-theme), which is also MIT licensed. Copyright (c) 2021 Nordic Semiconductor ASA.
Installation
This theme is distributed on PyPI as sphinx-tsn-theme and can be installed with pip:
pip install sphinx-tsn-theme
Usage
To use the theme in your Sphinx project, you will need to add the following to your conf.py file:
html_theme = "sphinx_tsn_theme"
Releasing
Make sure you have a PyPI account and access to https://pypi.org/project/sphinx-tsn-theme/.
Make sure all your changes have been commited to the main branch.
Add a commit which updates the version number in sphinx_tsn_theme/__init__.py.
Tag this commit with the version number, e.g. git tag -a 2020.4 -m "version 2020.4".
Push the commit and the tag to the main branch.
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 Distributions
Built Distribution
Hashes for sphinx_tsn_theme-2022.10.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30ff4ee4a902d3751079ecf265373c2eb43aa3ef5ab8eb38181420c1e281e78a |
|
MD5 | cc8ecef62b3664cde141565c8a3b274f |
|
BLAKE2b-256 | e9e9e13a70c28d5c04fb64b0ca7bc0b43be7e0f50b41aec547de7543a6a3f760 |