Skip to content

Commit

Permalink
Switch to the new tmt logo (#3361)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinhoyer authored Dec 9, 2024
1 parent 5d48814 commit e12ded3
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 16 deletions.
13 changes: 1 addition & 12 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ STEPS = discover provision prepare execute finish report
# A list of `plugins/*.rst` files to generate
PLUGIN_TARGETS = $(addsuffix .rst,$(addprefix plugins/,$(STEPS))) plugins/test-checks.rst

# A source of logo picture for Sphinx docs favicon
LOGO_SRC = https://raw.githubusercontent.com/teemtee/docs/main/logo/tmt-small.png

# Local filepath to fetched logo
LOGO_DST = _static/tmt-small.png

.DEFAULT_GOAL := help

.PHONY: help \
Expand Down Expand Up @@ -75,11 +69,6 @@ define plugins-checks-dependencies =
$(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/__init__.py $(TMTDIR)/checks/*.py
endef

# We can ignore the error: later, during the build, if the logo is
# missing, Sphinx will complain.
$(LOGO_DST):
-curl -f $(LOGO_SRC) -o $(LOGO_DST)

# Generate plugin documentation sources for a given step
define build-plugins =
$(SCRIPTSDIR)/generate-plugins.py $(call plugins-to-step,$@) $(PLUGINS_TEMPLATE) $@
Expand Down Expand Up @@ -146,7 +135,7 @@ generate-stories: stories $(TEMPLATESDIR)/story.rst.j2 ## Generate documentatio
generate-template-filters: code/template-filters.rst ## Generate documentation sources for Jinja2 template filters

clean: ## Remove all generated content
rm -rf _build $(GENERATED_DIRECTORIES) code/autodocs/*.rst code/template-filters.rst plugins/hardware-matrix.rst guide/test-runner-guest-compatibility-matrix.inc.rst $(PLUGIN_TARGETS) $(LOGO_DST)
rm -rf _build $(GENERATED_DIRECTORIES) code/autodocs/*.rst code/template-filters.rst plugins/hardware-matrix.rst guide/test-runner-guest-compatibility-matrix.inc.rst $(PLUGIN_TARGETS)

##
## Help!
Expand Down
3 changes: 3 additions & 0 deletions docs/_static/tmt-custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
/* Used for HW requirement support matrix */
.supported { color: green; }
.unsupported { color: red; }
.logo {
padding: 10px 50px !important;
}
7 changes: 3 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -217,12 +217,11 @@ def _load_theme(

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'https://raw.githubusercontent.com/teemtee/docs/main/logo/tmt-transparent-175x175.png'
html_logo = 'https://raw.githubusercontent.com/teemtee/docs/main/logo/tmt-logo-dark-background.png'

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = 'https://raw.githubusercontent.com/teemtee/docs/main/logo/tmt-favicon.ico'
# docs.
html_favicon = 'https://raw.githubusercontent.com/teemtee/docs/main/logo/tmt-logo-dark-background.svg'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
4 changes: 4 additions & 0 deletions docs/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ calling the ``tmt-report-result`` or by calling beakerlib's
``rlPhaseEnd`` saved in ``results.yaml`` are now relative to the
``execute`` directory.

Documentation pages now use the `new tmt logo`__ designed by Maria Leonova.

__ https://github.com/teemtee/docs/tree/main/logo


tmt-1.39.0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit e12ded3

Please sign in to comment.