Skip to content

Commit

Permalink
Update 1.8 release docs (#1216)
Browse files Browse the repository at this point in the history
* update docs

* update docs

* Update CHANGELOG.md

* Update CHANGELOG.md

* list icons
  • Loading branch information
dgarcia360 authored Sep 24, 2024
1 parent 566db08 commit f33c6f6
Show file tree
Hide file tree
Showing 21 changed files with 901 additions and 66 deletions.
Binary file removed docs/source/configuration/images/deprecated.png
Binary file not shown.
Binary file removed docs/source/configuration/images/unstable.png
Binary file not shown.
9 changes: 7 additions & 2 deletions docs/source/configuration/multiversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ In this case, you can mark the version as unstable in the ``conf.py`` file.
By doing so, the warning message that appears at the top of the page will change to:

.. image:: images/unstable.png
.. code-block:: rst
You are viewing documentation for an unstable version of <PROJECT_NAME>. Switch to the latest stable version.
Defining deprecated versions
----------------------------
Expand All @@ -81,7 +83,10 @@ In this case, you can mark the version as deprecated in the ``conf.py`` file.
By doing so, the warning message that appears at the top of the page will change to:

.. image:: images/deprecated.png
.. code-block:: rst
You are viewing documentation for a deprecated version of <PROJECT_NAME>. Switch to the latest stable version.
Previewing local changes with multiversion
------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions docs/source/examples/hero-box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Using:
:title: Lorem Ipsum
:image: /_static/img/mascots-2/enterprise.svg
:button_url: #
:button_icon: fa fa-github
:button_icon: icon-github
:button_text: Project Name
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Expand All @@ -195,7 +195,7 @@ Results in:
.. hero-box::
:title: Lorem Ipsum
:image: /_static/img/mascots-2/enterprise.svg
:button_icon: fa fa-github
:button_icon: icon-github
:button_url: #
:button_text: Project Name

Expand All @@ -212,7 +212,7 @@ Using:
:title: Lorem Ipsum
:image: /_static/img/mascots-2/enterprise.svg
:button_url: #
:button_icon: fa fa-github
:button_icon: icon-github
:button_icon_position: right
:button_text: Project Name
Expand All @@ -223,7 +223,7 @@ Results in:
.. hero-box::
:title: Lorem Ipsum
:image: /_static/img/mascots-2/enterprise.svg
:button_icon: fa fa-github
:button_icon: icon-github
:button_icon_position: right
:button_url: #
:button_text: Project Name
Expand Down Expand Up @@ -318,7 +318,7 @@ Hero box with everything
:button_text: Project Name
:button_url: #
:button_style: bold
:button_icon: fa fa-github
:button_icon: icon-arrow-right
:button_icon_position: right
:button_icon_link:
:cta: Learn more
Expand All @@ -334,7 +334,7 @@ Results in:
:button_text: Project Name
:button_url: #
:button_style: bold
:button_icon: fa fa-arrow-right
:button_icon: icon-arrow-right
:button_icon_position: right
:button_icon_link:
:cta: Learn more
Expand Down
Loading

0 comments on commit f33c6f6

Please sign in to comment.