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

Update 1.8 release docs #1216

Merged
merged 5 commits into from
Sep 24, 2024
Merged

Update 1.8 release docs #1216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
95816b0
update docs
dgarcia360 Sep 20, 2024
1ef9364
update docs
dgarcia360 Sep 20, 2024
19da47b
Update CHANGELOG.md
dgarcia360 Sep 20, 2024
450e293
Update CHANGELOG.md
dgarcia360 Sep 20, 2024
62dd1bc
list icons
dgarcia360 Sep 20, 2024
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
Binary file removed docs/source/configuration/images/deprecated.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs/source/configuration/images/unstable.png
View file
Open in desktop
Binary file not shown.
9 changes: 7 additions & 2 deletions docs/source/configuration/multiversion.rst
View file
Open in desktop
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
View file
Open in desktop
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