Skip to main content

A Sphinx theme for Renku documentation.

Project description

https://github.com/SwissDataScienceCenter/renku-sphinx-theme/actions/workflows/test.yml/badge.svg https://img.shields.io/github/tag/SwissDataScienceCenter/renku-sphinx-theme.svg https://img.shields.io/pypi/dm/renku-sphinx-theme.svg https://img.shields.io/github/license/SwissDataScienceCenter/renku-sphinx-theme.svg

A Sphinx theme for Renku documentation based on RTD theme.

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

Installation

  1. Add renku-sphinx-theme to setup.py or requirements.txt used for building your documentation.

  2. Set html_theme to 'renku' in docs/conf.py.

  3. 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

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

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

  3. 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

  1. Create a pull request updating renku_sphinx_theme/version.py to the new version number and CHANGES.rst to list the new changes.

  2. Once the pull request is merged, create a new release.

  3. The release will be automatically be pushed to PyPI.

Changes

0.5.0 (2025-01-24)

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

0.4.0 (2025-01-23)

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

0.3.0 (2023-08-14)

Big dependency update.

0.2.3 (2023-04-26)

  • chore: add dependabot.yml (76baee5)

  • chore: remove dependency on non-existent compile-scss (617e566)

  • chore: fix pypi description (23536d9)

  • chore(deps): update sphinx-rtd-theme requirement (2ca96ca)

  • chore: bump python version (0dd1fe6)

  • chore: delete layout.html (5fa988d)

  • fix: update styles to fix sidebar background leaking into main content (5ab737b)

0.2.2 (2021-07-09)

  • design: new design for renku-sphinx (3cf7ec7)

  • chore: replace travis CI with github actions (4056830)

0.1.0 (2018-05-17)

  • Initial public release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

renku-sphinx-theme-0.5.0.tar.gz (586.8 kB view details)

Uploaded Source

Built Distribution

renku_sphinx_theme-0.5.0-py2.py3-none-any.whl (580.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file renku-sphinx-theme-0.5.0.tar.gz.

File metadata

  • Download URL: renku-sphinx-theme-0.5.0.tar.gz
  • Upload date:
  • Size: 586.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for renku-sphinx-theme-0.5.0.tar.gz
Algorithm Hash digest
SHA256 8fcf80b854681119ee4dd6268c6a4ed80f9303a3fa9fdc020fd1cb4926dc4c6e
MD5 be89e3ec44875933aa34f47ea8b1f0d3
BLAKE2b-256 4e36123a101a93f1906c146b58d3d59512a1b7ced5fc69bb56fe6571af13303e

See more details on using hashes here.

File details

Details for the file renku_sphinx_theme-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for renku_sphinx_theme-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1bd92cf728c00d539ebbaa59bb3d5e8eee977ad0aecaa3034962a315b8fa42aa
MD5 d44bdf6879229b8e2d60930756fd3dce
BLAKE2b-256 9b00055a7d506281c1f16cc048d5c73ad41a44568c7a5f1fa7c56f349a41e671

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page