update_versions.py

Go to the documentation of this file.

#!/usr/bin/env python3
 
import os
import subprocess
import sys
 
def version_to_value(version):
    return list(map(int, version.lstrip('v').split('.')))
 
if __name__ == "__main__":
    entry_template = """\
        <tr>
          <td>%(version)s%(current)s</td>
          <td><a href="/fusion-engine/%(version)s/index.html">Documentation</a></td>
          <td><a href="https://github.com/PointOneNav/fusion-engine-client/releases/tag/%(version)s">Release Notes</a></td>
        </tr>
"""
 
    entry_template_no_docs = """\
        <tr>
          <td>%(version)s%(current)s</td>
          <td></td>
          <td><a href="https://github.com/PointOneNav/fusion-engine-client/releases/tag/%(version)s">Release Notes</a></td>
        </tr>
"""
 
    # List available versions.
 
    versions = subprocess.check_output(['git', 'tag']).decode('utf-8').strip().split()
    versions.sort(key=version_to_value, reverse=True)
    latest_version = versions[0]
 
    FIRST_RELEASE_WITH_DOCS = [1, 4, 0]
 
    # Find the docs/ directory.
    docs_dir = os.path.dirname(os.path.abspath(__file__))
 
    # Set version number in Doxyfile.
    if len(sys.argv) > 1:
        current_version = sys.argv[1]
 
        with open('%s/../Doxyfile' % docs_dir, 'r') as f:
            file_contents = f.read()
            file_contents = file_contents.format(current_version=current_version)
        with open('%s/../Doxyfile.version' % docs_dir, 'w') as f:
            f.write(file_contents)
 
    # Generate include_header.js.
    with open('%s/include_header.js.template' % docs_dir, 'r') as f:
        file_contents = f.read()
        with open('%s/include_header.js' % docs_dir, 'w') as f:
            f.write(file_contents % {'latest_version': latest_version})
 
    # Generate versions.html.
    with open('%s/versions.html.template' % docs_dir, 'r') as f:
        file_contents = f.read()
 
        table_contents = ""
        for version in versions:
            value = version_to_value(version)
            if value >= FIRST_RELEASE_WITH_DOCS:
                template = entry_template
            else:
                template = entry_template_no_docs
 
            table_contents += template % {'version': version,
                                          'current': ' (Current)' if version == latest_version else ''}
 
        with open('%s/versions.html' % docs_dir, 'w') as f:
            f.write(file_contents % {'content': table_contents})