Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch to new tmt logo #3361

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Switch to new tmt logo #3361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,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 All @@ -45,7 +39,7 @@ LOGO_DST = _static/tmt-small.png
##
## Generate documentation sources from inputs
##
generate: $(LOGO_DST) generate-lint-checks generate-template-filters generate-plugins generate-stories generate-autodocs ## Refresh all generated documentation sources
generate: generate-lint-checks generate-template-filters generate-plugins generate-stories generate-autodocs ## Refresh all generated documentation sources

#
# Targets creating directories for generated documentation sources
Expand All @@ -72,11 +66,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 @@ -136,7 +125,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 $(PLUGIN_TARGETS) $(LOGO_DST)
rm -rf _build $(GENERATED_DIRECTORIES) code/autodocs/*.rst code/template-filters.rst plugins/hardware-matrix.rst $(PLUGIN_TARGETS)

##
## Help!
Expand Down
3 changes: 3 additions & 0 deletions docs/_static/tmt-custom.css
View file
Open in desktop
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;
}
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ 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-color-f.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
Expand Down
Loading