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``:
.. code-block:: console
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:
.. code-block:: python
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 <https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives>`__.
7. `Upload the two files from step 6 to PyPI with twine <https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives>`__.
.. _Sphinx theme: https://www.sphinx-doc.org/en/master/usage/theming.html
.. _Read The Docs: https://readthedocs.org/
.. _sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme
.. _sphinx-ncs-theme: https://github.com/nrfconnect/doc-sphinx-ncs-theme
.. _sphinx-tsn-theme: https://pypi.org/project/sphinx-tsn-theme/
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-tsn-theme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Stephan Linz <linz@li-pro.net>, TiaC Systems Network <info@tiac-systems.net>",
"keywords": "sphinx, theme, TiaC Systems Network, tiac, tiacsys, tsn",
"author": null,
"author_email": "Stephan Linz <linz@li-pro.net>, Sarah Renkhoff <sarah.renkhoff@navimatix.de>, Tobias K\u00e4stner <tobias.kaestner.jena@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/f1/8aa51f277cff45adb7205a6632f8ea1780c68d7a5c0db94a9dd6bba6bf59/sphinx_tsn_theme-2024.11.0.tar.gz",
"platform": null,
"description": "TiaC Systems Network (TSN) theme for Sphinx\n===========================================\n\nThis repository contains the `Sphinx theme`_ for TiaC Systems Network (TSN)\ndocumentation, based on `Read The Docs`_' default theme (sphinx_rtd_theme_).\nThis theme was forked from the Nordic Semiconductor NCS theme for Sphinx\n(sphinx-ncs-theme_), which is also MIT licensed.\nCopyright (c) 2021 Nordic Semiconductor ASA.\n\nInstallation\n------------\n\nThis theme is distributed on PyPI as sphinx-tsn-theme_ and can be installed\nwith ``pip``:\n\n.. code-block:: console\n\n pip install sphinx-tsn-theme\n\nUsage\n-----\n\nTo use the theme in your Sphinx project, you will need to add the following to\nyour ``conf.py`` file:\n\n.. code-block:: python\n\n html_theme = \"sphinx_tsn_theme\"\n\nReleasing\n---------\n\n1. Make sure you have a PyPI account and access to https://pypi.org/project/sphinx-tsn-theme/.\n2. Make sure all your changes have been commited to the ``main`` branch.\n3. Add a commit which updates the version number in ``sphinx_tsn_theme/__init__.py``.\n4. Tag this commit with the version number, e.g. ``git tag -a 2020.4 -m \"version 2020.4\"``.\n5. Push the commit and the tag to the ``main`` branch.\n6. `Generate the source and binary distributions with setup.py <https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives>`__.\n7. `Upload the two files from step 6 to PyPI with twine <https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives>`__.\n\n.. _Sphinx theme: https://www.sphinx-doc.org/en/master/usage/theming.html\n.. _Read The Docs: https://readthedocs.org/\n.. _sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme\n.. _sphinx-ncs-theme: https://github.com/nrfconnect/doc-sphinx-ncs-theme\n.. _sphinx-tsn-theme: https://pypi.org/project/sphinx-tsn-theme/\n\n",
"bugtrack_url": null,
"license": null,
"summary": "TiaC Systems Network (TSN) theme for Sphinx",
"version": "2024.11.0",
"project_urls": {
"Changelog": "https://github.com/tiacsys/sphinx-tsn-theme/releases",
"Documentation": "https://github.com/tiacsys/sphinx-tsn-theme#readme-ov-file",
"Download": "https://pypi.org/project/sphinx-tsn-theme/",
"GitHub": "https://github.com/tiacsys/sphinx-tsn-theme",
"Homepage": "https://www.tiac-systems.net/",
"Issues": "https://github.com/tiacsys/sphinx-tsn-theme/issues",
"Repository": "https://github.com/tiacsys/sphinx-tsn-theme.git"
},
"split_keywords": [
"sphinx",
" theme",
" tiac systems network",
" tiac",
" tiacsys",
" tsn"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "777276af42f0fd7a5c2f33b35bffdd8d82e6daf3cd83a6146878dc764d603045",
"md5": "70ccfa5fad49432b458db97c10011011",
"sha256": "654af8c88ab55b2f728599eb2172b525d10871c4f3b792922e15a7d92d673c65"
},
"downloads": -1,
"filename": "sphinx_tsn_theme-2024.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70ccfa5fad49432b458db97c10011011",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21448,
"upload_time": "2024-11-20T11:23:03",
"upload_time_iso_8601": "2024-11-20T11:23:03.152014Z",
"url": "https://files.pythonhosted.org/packages/77/72/76af42f0fd7a5c2f33b35bffdd8d82e6daf3cd83a6146878dc764d603045/sphinx_tsn_theme-2024.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5f18aa51f277cff45adb7205a6632f8ea1780c68d7a5c0db94a9dd6bba6bf59",
"md5": "ec22466918a2d4a1d39fd7471ff3ff4e",
"sha256": "3004b95da1a6b8e8163268eae398ad0f15f7e7dcce085620384d41c483ab32b8"
},
"downloads": -1,
"filename": "sphinx_tsn_theme-2024.11.0.tar.gz",
"has_sig": false,
"md5_digest": "ec22466918a2d4a1d39fd7471ff3ff4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20595,
"upload_time": "2024-11-20T11:23:04",
"upload_time_iso_8601": "2024-11-20T11:23:04.820198Z",
"url": "https://files.pythonhosted.org/packages/e5/f1/8aa51f277cff45adb7205a6632f8ea1780c68d7a5c0db94a9dd6bba6bf59/sphinx_tsn_theme-2024.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 11:23:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tiacsys",
"github_project": "sphinx-tsn-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-tsn-theme"
}
JSON
