Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.79 KB

README.rst

File metadata and controls

45 lines (33 loc) · 1.79 KB
Raw

TiaC Systems Network (TSN) theme for Sphinx

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

  1. Make sure you have a PyPI account and access to https://pypi.org/project/sphinx-tsn-theme/.
  2. Make sure all your changes have been commited to the main branch.
  3. Add a commit which updates the version number in sphinx_tsn_theme/__init__.py.
  4. Tag this commit with the version number, e.g. git tag -a 2020.4 -m "version 2020.4".
  5. Push the commit and the tag to the main branch.
  6. Generate the source and binary distributions with setup.py.
  7. Upload the two files from step 6 to PyPI with twine.