Multi version support

lasote · lasote · commit 648731cbb282 · 2018-05-08T10:00:00.000+02:00
diff --git a/__init__.py b/__init__.py
diff --git a/_themes/conan/layout.html b/_themes/conan/layout.html
@@ -105,17 +105,11 @@
           {% endif %}
           </a>
 
-          {% if theme_display_version %}
-            {%- set nav_version = version %}
-            {% if READTHEDOCS and current_version %}
-              {%- set nav_version = current_version %}
-            {% endif %}
             {% if nav_version %}
               <div class="version">
-                {{ nav_version }}
+                {{ current_version }}
               </div>
             {% endif %}
-          {% endif %}
 
           {% include "searchbox.html" %}
 
diff --git a/_themes/conan/theme.conf b/_themes/conan/theme.conf
@@ -11,4 +11,4 @@ collapse_navigation = False
 display_version = True
 navigation_depth = 4
 prev_next_buttons_location = bottom
-base_url = 
+base_url =
diff --git a/_themes/conan/versions.html b/_themes/conan/versions.html
@@ -1,37 +1,23 @@
-{% if READTHEDOCS %}
 {# Add rst-badge after rst-versions for small badge style. #}
   <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <span class="rst-current-version" data-toggle="rst-current-version">
-      <span class="fa fa-book"> Read the Docs</span>
-      v: {{ current_version }}
+      <!--<span class="fa fa-pencil-square-o"> Other versions:</span> -->
+      Version: {{ current_version }}
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">
       <dl>
         <dt>{{ _('Versions') }}</dt>
-        {% for slug, url in versions %}
-          <dd><a href="{{ url }}">{{ slug }}</a></dd>
+        {% for slug, the_version in versions.items() %}
+           {% if the_version == "latest" %}
+                <dd><a href="/en/latest/index.html">{{ current_version }}</a></dd>
+           {% else %}
+                <dd><a href="/en/{{ the_version }}/index.html">{{ the_version }}</a></dd>
+           {% endif %}
         {% endfor %}
       </dl>
-      <dl>
-        <dt>{{ _('Downloads') }}</dt>
-        {% for type, url in downloads %}
-          <dd><a href="{{ url }}">{{ type }}</a></dd>
-        {% endfor %}
-      </dl>
-      <dl>
-        <dt>{{ _('On Read the Docs') }}</dt>
-          <dd>
-            <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
-          </dd>
-          <dd>
-            <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
-          </dd>
-      </dl>
       <hr/>
-      {% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %}
-
     </div>
   </div>
-{% endif %}
+
 
diff --git a/conf.py b/conf.py
@@ -35,6 +35,25 @@
     'conan',
 ]
 
+# The short X.Y version.
+version = "1.3"
+# The full version, including alpha/beta/rc tags.
+release = u'1.3.1'
+versions_dict = {"feature/multi_versions": "latest",
+                 "release/1.2.3": "1.2"}
+
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+
+
+html_context = {
+    "versions": versions_dict,
+    "current_version": version
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -54,14 +73,8 @@
 copyright = u'2016-2018, JFrog'
 author = u'conan'
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = u'1.3'
-# The full version, including alpha/beta/rc tags.
-release = u'1.3.1'
+
+
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -122,7 +135,7 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-  "base_url": "http://docs.conan.io/en/latest/"
+  "base_url": "http://docs.conan.io/en/latest/",
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
diff --git a/gh_pages.py b/gh_pages.py
@@ -1,6 +1,9 @@
 
 import os
 import shutil
+import tempfile
+
+from conf import versions_dict
 
 
 def copytree(src, dst, symlinks=False, ignore=None):
@@ -19,30 +22,51 @@ def call(command, ignore_error=False):
         raise Exception("Command failed: %s" % command)
 
 
-tmp_dir = os.getenv("CONANDOCS_TMP_DIR", "/tmp/docs")
 excluded_files = (".git", "CNAME", "index.html")
 
-if __name__ == "__main__":
+
+def clean_gh_pages():
+    call("git checkout gh-pages")
+    call("git pull origin gh-pages")
+    if os.path.exists("en"):
+        shutil.rmtree("en")
+
+
+def build_and_copy(branch, folder_name):
+    call("git checkout %s" % branch)
 
     call("make html")
-    call("make linkcheck")
+    # call("make linkcheck")
+    tmp_dir = tempfile.mkdtemp()
     if os.path.exists(tmp_dir):
         shutil.rmtree(tmp_dir)
     os.mkdir(tmp_dir)
 
     copytree("_build/html/", tmp_dir)
+    shutil.rmtree("_build")
+
+    # Go to deploy branch, copy new files and commit
     call("git checkout gh-pages")
-    call("git pull origin gh-pages")
+    if not os.path.exists("en"):
+        os.mkdir("en")
 
-    if os.path.exists("en"):
-        shutil.rmtree("en")
+    version_folder = "en/%s" % folder_name
+    if os.path.exists(version_folder):
+        shutil.rmtree(version_folder)
 
-    os.mkdir("en")
-    os.mkdir("en/latest")
-    
-    copytree(tmp_dir, "en/latest")
+    os.mkdir(version_folder)
+    copytree(tmp_dir, version_folder)
     call("git add -A .")
-    call("git commit -m 'deploying web'", ignore_error=True)
-    call("git push origin gh-pages", ignore_error=True)
-    call("git checkout master")
-    print("PUSHED!")
+    call("git commit -m 'committed version %s'" % folder_name, ignore_error=True)
+
+
+if __name__ == "__main__":
+
+    clean_gh_pages()
+
+    for branch, folder_name in versions_dict.items():
+        build_and_copy(branch, folder_name)
+
+    #call("git push origin gh-pages", ignore_error=True)
+
+    print("PUSH skipped, make sure all is ok and 'git push origin gh-pages'")
diff --git a/howtos/vs2017_cmake.rst b/howtos/vs2017_cmake.rst
@@ -165,28 +165,28 @@ All you need is to right click on your `conanfile.py`-> Configure Tasks (see the
 .. code-block:: text
   :emphasize-lines: 7,9,16,18
 
-  {
-    "tasks": [
-      {
-        "taskName": "conan install debug",
-        "appliesTo": "conanfile.py",
-        "type": "launch",
-        "command": "${env.COMSPEC}",
-        "args": [
-          "conan install ${file} -s build_type=Debug -if C:/Users/user/CMakeBuilds/4c2d87b9-ec5a-9a30-a47a-32ccb6cca172/build/x64-Debug/"
-        ]
-      },
       {
-        "taskName": "conan install release",
-        "appliesTo": "conanfile.py",
-        "type": "launch",
-        "command": "${env.COMSPEC}",
-        "args": [
-          "conan install ${file} -s build_type=Release -if C:/Users/user/CMakeBuilds/4c2d87b9-ec5a-9a30-a47a-32ccb6cca172/build/x64-Release/"
-        ]
+        "tasks": [
+          {
+            "taskName": "conan install debug",
+            "appliesTo": "conanfile.py",
+            "type": "launch",
+            "command": "${env.COMSPEC}",
+            "args": [
+              "conan install ${file} -s build_type=Debug -if C:/Users/user/CMakeBuilds/4c2d87b9-ec5a-9a30-a47a-32ccb6cca172/build/x64-Debug/"
+            ]
+          },
+          {
+            "taskName": "conan install release",
+            "appliesTo": "conanfile.py",
+            "type": "launch",
+            "command": "${env.COMSPEC}",
+            "args": [
+              "conan install ${file} -s build_type=Release -if C:/Users/user/CMakeBuilds/4c2d87b9-ec5a-9a30-a47a-32ccb6cca172/build/x64-Release/"
+            ]
+          }
+        ],
+        "version": "0.2.1"
       }
-    ],
-    "version": "0.2.1"
-  }
 
 Then just right click on your *conanfile.py* and launch your ``conan install`` and regenerate your *CMakeLists.txt*.
