Documentation | Quick Start Sources for Release is broken (#100)

[Amar Takhar (@amar)]

Amar Takhar commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/100#note_120802


We should use the only directive from Sphinx in order to make the text conditional.  We can have an admonish and point them to the downloads page https://www.rtems.org/download/ if they are looking for the release and then build the docs for a release.

This can be done with tags:

* https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only
* https://sublime-and-sphinx-guide.readthedocs.io/en/latest/conditions.html

The nice thing is you can supply multiple tags so for non-deploy docs we can have both main and release active to see all the text instead of having to rebuild the docs.  This can be the default for HEAD and when building deploy docs just supply the one tag.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/100#note_120802
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/20250312/087eec17/attachment.htm>