https://github.com/adfinis/adfinis-sphinx-theme
Sphinx and LaTeX templates for Adfinis
https://github.com/adfinis/adfinis-sphinx-theme
corporate-design corporate-identity sphinx-theme
Last synced: 3 months ago
JSON representation
Sphinx and LaTeX templates for Adfinis
- Host: GitHub
- URL: https://github.com/adfinis/adfinis-sphinx-theme
- Owner: adfinis
- Created: 2016-05-02T14:02:42.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T15:56:08.000Z (4 months ago)
- Last Synced: 2025-02-04T16:32:51.580Z (4 months ago)
- Topics: corporate-design, corporate-identity, sphinx-theme
- Language: Makefile
- Homepage:
- Size: 969 KB
- Stars: 7
- Watchers: 14
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Adfinis Sphinx Theme
This theme is just an addition to the [read the docs theme](https://sphinx-rtd-theme.readthedocs.io/).
It depends on the rtd theme and just adds custom fonts, image and a few lines of CSS for Adfinis colors.
It is a bit hacky as it just "overrides" certain variables in the configuration.
But this makes it extremely simple to install.
Maybe it makes sense to add an entrypoint which only adds the static files (or a config variable to do so).
## Usage
Add this project as dependency to `pyproject.toml`:
```bash
adfinis-sphinx-theme = { git = "https://github.com/adfinis/adfinis-sphinx-theme.git", branch = "main" }
```
Add the following to your sphinx `conf.py`:
```ini
extensions = [
# Add this to the extensions
'adfinis_sphinx_theme',
]
```
The following variables will be automatically [set/overriden](adfinis_sphinx_theme/__init__.py) by the theme:
- `html_title`
- `html_theme`
- `pygments_style`
- `html_logo` (This is not set but should be null, as the logo is inserted with CSS)
## Demo
The demo page can be built with:
poetry run sh -c 'cd example; make html'
# Notes
There used to be s5 and Latex changes to the rtd theme, but they were abandoned.
If they ought to be resurrected, check the git log.