Skip to main content

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.

Metadata

Release files for sphinx-tsn-theme 2024.11.0

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-tsn-theme 2024.11.0
File Size Uploaded Provenance Actions
sphinx_tsn_theme-2024.11.0.tar.gz 20.6 kB Without provenance Details for sphinx_tsn_theme-2024.11.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-tsn-theme 2024.11.0
File Interpreter ABI Platform Actions
sphinx_tsn_theme-2024.11.0-py3-none-any.whl Python 3 none any Details for sphinx_tsn_theme-2024.11.0-py3-none-any.whl

Total release size: 42.0 kB

Release files / sphinx_tsn_theme-2024.11.0.tar.gz

Download URL sphinx_tsn_theme-2024.11.0.tar.gz
Size 20.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3004b95da1a6b8e8163268eae398ad0f15f7e7dcce085620384d41c483ab32b8
BLAKE2b-256 checksum
How to use checksums
e5f18aa51f277cff45adb7205a6632f8ea1780c68d7a5c0db94a9dd6bba6bf59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / sphinx_tsn_theme-2024.11.0-py3-none-any.whl

Download URL sphinx_tsn_theme-2024.11.0-py3-none-any.whl
Size 21.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
654af8c88ab55b2f728599eb2172b525d10871c4f3b792922e15a7d92d673c65
BLAKE2b-256 checksum
How to use checksums
777276af42f0fd7a5c2f33b35bffdd8d82e6daf3cd83a6146878dc764d603045
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Security for sphinx-tsn-theme 2024.11.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page