Documentation | tag: Use only and tags to make conditional text (!163)

[Amar Takhar (@amar)]

Amar Takhar created a merge request: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/163

Project:Branches: amar/rtems-docs:only to rtems/docs/rtems-docs:main
Author:   Amar Takhar
Assignee: Amar Takhar



## Summary

tag: Use only and tags to make conditional text

There are currently only two tags devel and release the default tags are release,devel which will show both notes at the same time.

For development docs that are to be installed use --sphinx-tag=devel and for release docs --sphinx-tag=release

This will let us use conditional text for releases and development docs to avoid user confusion. Enabling the devel mode puts in place a warning which is in the common directory so they are uniform.

Closes #100

An example of what it looks like:

![image.png](/uploads/2190f7913d49c33f816169ae9ee1e529/image.png){width=425 height=167}

The warning only shows up for **devel** and the normal text for **release**  It is defaulted to both on.

<!--Default settings, if it is a dropdown it will set after submission-->

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/163
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20250314/2a4171c8/attachment.htm>