diff --git a/docs/source/configuration/template.rst b/docs/source/configuration/template.rst index b47309b69..86fc68733 100644 --- a/docs/source/configuration/template.rst +++ b/docs/source/configuration/template.rst @@ -80,7 +80,7 @@ Example: html_theme_options = { 'banner_button_text': 'Learn more', 'banner_button_url': '#', - 'banner_icon_path': '_static/mascots/scylla-opensource.svg', + 'banner_icon_path': '_static/mascots-2/default.svg', 'banner_title_text': 'ScyllaDB University Live | Free Virtual Training Event', 'hide_banner': 'true', } diff --git a/docs/source/examples/hero-box.rst b/docs/source/examples/hero-box.rst index 08df5bc76..de27d6458 100644 --- a/docs/source/examples/hero-box.rst +++ b/docs/source/examples/hero-box.rst @@ -77,7 +77,7 @@ The ``hero-box`` directive supports the following options: * - ``image`` - string - - - /_static/img/mascots/scylla-enterprise.svg + - /_static/img/mascots-2/enterprise.svg - Path to the image. The image should be located in the project's ``_static`` folder. * - ``search_box`` - flag @@ -116,7 +116,7 @@ Using: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -124,7 +124,7 @@ Results in: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -158,7 +158,7 @@ Using: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_url: # :button_text: Project Name @@ -168,7 +168,7 @@ Results in: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_url: # :button_text: Project Name @@ -183,7 +183,7 @@ Using: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_url: # :button_icon: fa fa-github :button_text: Project Name @@ -194,7 +194,7 @@ Results in: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_icon: fa fa-github :button_url: # :button_text: Project Name @@ -210,7 +210,7 @@ Using: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_url: # :button_icon: fa fa-github :button_icon_position: right @@ -222,7 +222,7 @@ Results in: .. hero-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_icon: fa fa-github :button_icon_position: right :button_url: # @@ -314,7 +314,7 @@ Hero box with everything .. hero-box:: :title: Lorem ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_text: Project Name :button_url: # :button_style: bold @@ -330,7 +330,7 @@ Results in: .. hero-box:: :title: Lorem ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :button_text: Project Name :button_url: # :button_style: bold diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index 8016e7e78..990e3b368 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -24,6 +24,7 @@ In general, there are main components to the markup of any document: labels links lists + mascots panel-box substitutions tables @@ -50,6 +51,7 @@ In general, there are main components to the markup of any document: * :doc:`Labels ` * :doc:`Links ` * :doc:`Lists ` + * :doc:`Mascots ` * :doc:`Panel box ` * :doc:`Substitutions ` * :doc:`Tables ` diff --git a/docs/source/examples/mascots.rst b/docs/source/examples/mascots.rst new file mode 100644 index 000000000..824dac9c6 --- /dev/null +++ b/docs/source/examples/mascots.rst @@ -0,0 +1,223 @@ +Mascots +======= + +Mascots can be used in :doc:`Topic box ` and :doc:`Hero box ` components. +The images are available in the ``_static`` folder of the project, under the ``img/mascots-2`` directory. + +Preview +------- + +.. raw:: html + +
+ +
+
+ +.. topic-box:: + :title: 2-monster-laptop + :link: # + :image: /_static/img/mascots-2/2-monster-laptop.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: alternator + :link: # + :image: /_static/img/mascots-2/alternator.svg + :class: topic-box--product,large-3,small-6 + + +.. topic-box:: + :title: award + :link: # + :image: /_static/img/mascots-2/award.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: care-pet + :link: # + :image: /_static/img/mascots-2/care-pet.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: cdc + :link: # + :image: /_static/img/mascots-2/cdc.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: chef + :link: # + :image: /_static/img/mascots-2/chef.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: cloud + :link: # + :image: /_static/img/mascots-2/cloud.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: default + :link: # + :image: /_static/img/mascots-2/default.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: docs + :link: # + :image: /_static/img/mascots-2/docs.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: driver + :link: # + :image: /_static/img/mascots-2/driver.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: forward + :link: # + :image: /_static/img/mascots-2/forward.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: forward-2 + :link: # + :image: /_static/img/mascots-2/forward-2.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: headphones + :link: # + :image: /_static/img/mascots-2/headphones.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: heart + :link: # + :image: /_static/img/mascots-2/heart.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: laptop + :link: # + :image: /_static/img/mascots-2/laptop.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: magnifying-glass + :link: # + :image: /_static/img/mascots-2/magnifying-glass.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: manager + :link: # + :image: /_static/img/mascots-2/manager.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: monitor + :link: # + :image: /_static/img/mascots-2/monitor.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: open-mouth + :link: # + :image: /_static/img/mascots-2/open-mouth.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: operator + :link: # + :image: /_static/img/mascots-2/operator.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: plug + :link: # + :image: /_static/img/mascots-2/plug.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: repair + :link: # + :image: /_static/img/mascots-2/repair.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: server + :link: # + :image: /_static/img/mascots-2/server.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: sleepy + :link: # + :image: /_static/img/mascots-2/sleepy.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: smile-learning + :link: # + :image: /_static/img/mascots-2/smile-learning.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: stretched-up + :link: # + :image: /_static/img/mascots-2/stretched-up.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: toolbox + :link: # + :image: /_static/img/mascots-2/toolbox.svg + :class: topic-box--product,large-3,small-6 + +.. topic-box:: + :title: university + :link: # + :image: /_static/img/mascots-2/university.svg + :class: topic-box--product,large-3,small-6 + +.. raw:: html + +
+ +Reference +--------- + +Available mascot images: + +- ``/_static/img/mascots-2/2-monster-laptop.svg`` +- ``/_static/img/mascots-2/alternator.svg`` +- ``/_static/img/mascots-2/award.svg`` +- ``/_static/img/mascots-2/care-pet.svg`` +- ``/_static/img/mascots-2/cdc.svg`` +- ``/_static/img/mascots-2/chef.svg`` +- ``/_static/img/mascots-2/cloud.svg`` +- ``/_static/img/mascots-2/default.svg`` +- ``/_static/img/mascots-2/docs.svg`` +- ``/_static/img/mascots-2/driver.svg`` +- ``/_static/img/mascots-2/forward.svg`` +- ``/_static/img/mascots-2/forward-2.svg`` +- ``/_static/img/mascots-2/headphones.svg`` +- ``/_static/img/mascots-2/heart.svg`` +- ``/_static/img/mascots-2/laptop.svg`` +- ``/_static/img/mascots-2/magnifying-glass.svg`` +- ``/_static/img/mascots-2/manager.svg`` +- ``/_static/img/mascots-2/monitor.svg`` +- ``/_static/img/mascots-2/open-mouth.svg`` +- ``/_static/img/mascots-2/operator.svg`` +- ``/_static/img/mascots-2/plug.svg`` +- ``/_static/img/mascots-2/repair.svg`` +- ``/_static/img/mascots-2/server.svg`` +- ``/_static/img/mascots-2/sleepy.svg`` +- ``/_static/img/mascots-2/smile-learning.svg`` +- ``/_static/img/mascots-2/stretched-up.svg`` +- ``/_static/img/mascots-2/toolbox.svg`` +- ``/_static/img/mascots-2/university.svg`` + diff --git a/docs/source/examples/topic-box.rst b/docs/source/examples/topic-box.rst index 414eaee24..3f64ec36e 100644 --- a/docs/source/examples/topic-box.rst +++ b/docs/source/examples/topic-box.rst @@ -47,7 +47,7 @@ The ``topic-box`` directive supports the following options: * - ``image`` - string - - - /_static/img/mascots/scylla-enterprise.svg + - /_static/img/mascots-2/enterprise.svg - Path to the image. The image should be located in the project's ``_static`` folder. * - ``link`` - string @@ -102,7 +102,7 @@ Using: .. topic-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :link: # :anchor: Lorem ipsum @@ -112,7 +112,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :link: # :anchor: Lorem ipsum @@ -256,7 +256,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -266,7 +266,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -298,7 +298,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -306,7 +306,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -314,7 +314,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -322,7 +322,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -330,7 +330,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -338,7 +338,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -346,7 +346,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -354,7 +354,7 @@ Using: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -379,7 +379,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -387,7 +387,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -395,7 +395,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -403,7 +403,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -411,7 +411,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -419,7 +419,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -427,7 +427,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. @@ -435,7 +435,7 @@ Results in: .. topic-box:: :title: Lorem Ipsum :link: # - :image: /_static/img/mascots/scylla-enterprise.svg + :image: /_static/img/mascots-2/enterprise.svg :class: topic-box--product,large-3,small-6 Lorem ipsum dolor sit amet, consectetur adipiscing elit. diff --git a/docs/source/index.rst b/docs/source/index.rst index 2be334a0f..538610cd1 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,7 +14,7 @@ :button_url: https://github.com/scylladb/sphinx-scylladb-theme :button_text: Source code :title: Welcome to ScyllaDB Sphinx Theme documentation - :image: /_static/img/mascots/scylla-docs.svg + :image: /_static/img/mascots-2/docs.svg The documentation toolchain for ScyllaDB projects. diff --git a/sphinx_scylladb_theme/404.html b/sphinx_scylladb_theme/404.html index 9e6ab091b..5af8eca3b 100644 --- a/sphinx_scylladb_theme/404.html +++ b/sphinx_scylladb_theme/404.html @@ -18,7 +18,7 @@ - +

404

The ScyllaDB monster ate your page!

diff --git a/sphinx_scylladb_theme/footer.html b/sphinx_scylladb_theme/footer.html index 550cdea6c..441afd84a 100644 --- a/sphinx_scylladb_theme/footer.html +++ b/sphinx_scylladb_theme/footer.html @@ -2,7 +2,7 @@
Docs diff --git a/sphinx_scylladb_theme/header.html b/sphinx_scylladb_theme/header.html index 105ee2698..76066ce0b 100644 --- a/sphinx_scylladb_theme/header.html +++ b/sphinx_scylladb_theme/header.html @@ -1,7 +1,7 @@