renku-sphinx-theme

.. Copyright 2017 Swiss Data Science Center (SDSC) A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and Eidgenössische Technische Hochschule Zürich (ETHZ).

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

================================= Sphinx Theme for Renku Projects

.. image:: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/actions/workflows/test.yml/badge.svg :target: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/actions?query=branch%3Amaster

.. image:: https://img.shields.io/github/tag/SwissDataScienceCenter/renku-sphinx-theme.svg :target: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/releases

.. image:: https://img.shields.io/pypi/dm/renku-sphinx-theme.svg :target: https://pypi.python.org/pypi/renku-sphinx-theme

.. image:: https://img.shields.io/github/license/SwissDataScienceCenter/renku-sphinx-theme.svg :target: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/blob/master/LICENSE

A Sphinx theme for Renku documentation based on RTD theme.

https://renku-sphinx-theme.readthedocs.io/en/latest/

Installation

• Add renku-sphinx-theme to setup.py or requirements.txt used for building your documentation.
• Set html_theme to 'renku' in docs/conf.py.
• Configure at least description and github_repo in html_theme_options.

Enjoy your beautiful Renku documentation style.

Style (css)

This repo contains a scss file that generates a css file. The css file shouldn't be manually modified since it's generated with the scss. Instructions to change and run the scss file are inside it ./renku_sphinx_theme/static/custom.scss.

Renku repo is a better repository for testing style changes.

The easy way of doing this is to go to the renku repo, add a temporary css (custom.css) in the docs/conf.py file and follow this steps:

https://renku.readthedocs.io/en/latest/how-to-guides/contributing/documentation.html

After doing the changes in the temporary css add this to custom.scss in this repository, build this into a css file using the instructions and commit the css and scss files.

Building

To build docs after doing changes, and test things inside this repository

• From the base folder... pip install -r docs/requirements.txt

• This should be done in case there where changes in fonts or new css files added pip install --editable .

• There is no Makefile here but in order to do the "make html" action you should do

  cd docs sphinx-build -b html -d _build/doctrees . _build/html

Docs will be built into _build/html... open this files with chrome to see the changes.

Releasing

• Create a pull request updating renku_sphinx_theme/version.py to the new version number and CHANGES.rst to list the new changes.
• Once the pull request is merged, create a new release <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/releases/new>__.
• The release will be automatically be pushed to PyPI <https://pypi.org/project/renku-sphinx-theme/>__.

.. Copyright 2017 Swiss Data Science Center (SDSC) A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and Eidgenössische Technische Hochschule Zürich (ETHZ).

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Changes

0.5.0 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/compare/v0.4.0...v0.5.0>__ (2025-01-24)

This release makes minor changes for compatibility with sphinx>=8 and sphinx-rtd-theme>=3.

0.4.0 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/compare/v0.3.0...v0.4.0>__ (2025-01-23)

This release bumps sphinx-rtd-theme dependency to make the style compatible with sphinx 7+

0.3.0 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/compare/v0.2.3...v0.3.0>__ (2023-08-14)

Big dependency update.

0.2.3 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/compare/v0.2.2...v0.2.3>__ (2023-04-26)

• chore: add dependabot.yml (76baee5 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/76baee53a3dea65e44c862e3d39836bced35f205>__)

• chore: remove dependency on non-existent compile-scss (617e566 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/617e566bc4821c31e42d544c6abda9399c5cbde5>__)

• chore: fix pypi description (23536d9 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/23536d9e40efdd3701a76074e377f2236d336cdf>__)

• chore(deps): update sphinx-rtd-theme requirement (2ca96ca <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/2ca96ca9b932de2ba2f2434f0bb962d06d0a6620>__)

• chore: bump python version (0dd1fe6 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/0dd1fe66db3b1d1c587ca534bb04c9a6c148de92>__)

• chore: delete layout.html (5fa988d <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/5fa988d54609cfe3f593ca252af7925acd12eeef>__)

• fix: update styles to fix sidebar background leaking into main content (5ab737b <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/5ab737bf48f7757ff1fb4464538f851da5918aa9>__)

0.2.2 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/compare/v0.1.0...v0.2.2>__ (2021-07-09)

• design: new design for renku-sphinx (3cf7ec7 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/3cf7ec746996411408267cb952f500481aac805b>__)

• chore: replace travis CI with github actions (4056830 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/commit/40568301b0d95865db8835360b6b2ddd873ceccd>__)

0.1.0 <https://github.com/SwissDataScienceCenter/renku-sphinx-theme/releases/tag/v0.1.0>__ (2018-05-17)

• Initial public release.