From 85a06360455fe5ff51f566534c5afcda2cc9e974 Mon Sep 17 00:00:00 2001 From: Leonard Xu Date: Fri, 6 Aug 2021 00:39:22 +0800 Subject: [PATCH] [doc] Support versioned documents with RTD(ReadTheDocs) --- docs/_templates/versions.html | 55 +++++++++++++++++++++++++++++++++++ pom.xml | 1 + 2 files changed, 56 insertions(+) create mode 100644 docs/_templates/versions.html diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html new file mode 100644 index 000000000..90fdc4a06 --- /dev/null +++ b/docs/_templates/versions.html @@ -0,0 +1,55 @@ +{% if READTHEDOCS or display_lower_left %} +{# Add rst-badge after rst-versions for small badge style. #} +
+ + Read the Docs + v: {{ current_version }} + + +
+ {% if languages|length >= 1 %} +
+
{{ _('Languages') }}
+ {% for slug, url in languages %} + {% if slug == current_language %} {% endif %} +
{{ slug }}
+ {% if slug == current_language %}
{% endif %} + {% endfor %} +
+ {% endif %} + {% if versions|length >= 1 %} +
+
{{ _('Versions') }}
+ {% for slug, url in versions %} + {% if slug == current_version %} {% endif %} +
{{ slug }}
+ {% if slug == current_version %}
{% endif %} + {% endfor %} +
+ {% endif %} + {% if downloads|length >= 1 %} +
+
{{ _('Downloads') }}
+ {% for type, url in downloads %} +
{{ type }}
+ {% endfor %} +
+ {% endif %} + {% if READTHEDOCS %} +
+
{{ _('On Read the Docs') }}
+
+ {{ _('Project Home') }} +
+
+ {{ _('Builds') }} +
+
+ {% endif %} +
+ {% trans %}Free document hosting provided by Read the Docs.{% endtrans %} + +
+
+{% endif %} + diff --git a/pom.xml b/pom.xml index baec37c34..6d653acbe 100644 --- a/pom.xml +++ b/pom.xml @@ -182,6 +182,7 @@ under the License. **/*.md docs/Makefile docs/make.bat + docs/_templates/version.html **/*.txt