docs: Place warning at the top of every page in /latest/production.

- Added warning block to dev docs using _templates/layout.html
- Removed copy-pasted warning from install.md and requirements.md
- Removed unreleased tag in docs/conf.py that's no longer used

Useful ref: https://www.sphinx-doc.org/en/master/templating.html

Fixes #13056.
This commit is contained in:
David Rosa
2019-08-27 00:10:54 -07:00
committed by Tim Abbott
parent e64b5a2b88
commit 4afdfa6055
4 changed files with 26 additions and 41 deletions

26
docs/_templates/layout.html vendored Normal file
View File

@@ -0,0 +1,26 @@
{% extends "!layout.html" %}
{% block document %}
<!---
# This allows us to insert a warning that appears only on the development
# version e.g. to say that something is likely to have changed.
# For more info see: https://www.sphinx-doc.org/en/master/templating.html
-->
{% if pagename == "production/email-gateway" and release.endswith('+git') %}
<!--
# email-gateway.html page doesn't exist in the stable documentation yet.
# This temporary workaround prevents CircleCI failure and should be removed after the next release.
-->
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">You are reading a <strong>development version</strong> of the Zulip documentation. These instructions may not correspond to the latest Zulip Server release.
See <a class="reference external" href="https://zulip.readthedocs.io/en/stable/production">documentation for the latest stable release</a>.</p>
</div>
{% elif pagename.split("/")[0] == "production" and release.endswith('+git') %}
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">You are reading a <strong>development version</strong> of the Zulip documentation. These instructions may not correspond to the latest Zulip Server release.
See <a class="reference external" href="https://zulip.readthedocs.io/en/stable/{{ pagename }}.html">documentation for the latest stable release</a>.</p>
</div>
{% endif %}
{{ super() }}
{% endblock %}