https://github.com/coderefinery/sphinx-coderefinery-branding
https://github.com/coderefinery/sphinx-coderefinery-branding
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/coderefinery/sphinx-coderefinery-branding
- Owner: coderefinery
- Created: 2020-10-27T22:55:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T21:47:31.000Z (over 2 years ago)
- Last Synced: 2025-09-10T04:46:49.061Z (9 months ago)
- Language: Python
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
CodeRefinery branding for Sphinx
================================
This adds a HTML favicon to the Sphinx project to brand it for
CodeRefinery. But, so that others can fork our repositories without
misrepresenting the origin, it detects if the project is being built
in an official location, and only brands it in that case.
It detects the official locations via:
- The environment variable ``GITHUB_REPOSITORY`` starts with
``coderefinery``. `GitHub does this
`__.
- The environment variable ``CODEREFINERY`` is set.
This code has an open license (and also probably the projects that use
the code), but misrepresenting the author of a project is another
matter and not allowed! We aim to make it easy to satisfy that.
Derivative works should cite original source and briefly explain what
is different.
See also
--------
https://github.com/coderefinery/coderefinery-graphics
License
-------
This package, *except* for the logo icon itself, is licensed under the
CC-BY. Currently, no comment is made on the logo.