docs: deploy built docs

This commit is contained in:
Ivan Grokhotkov
2016-11-01 20:58:47 +08:00
parent 1d3626c119
commit 4f71d741ec
2 changed files with 44 additions and 5 deletions

View File

@@ -26,9 +26,20 @@ import os
# added by krzychb, 24-Oct-2016
#
from subprocess import call
from subprocess import call, Popen, PIPE
import shlex
call('doxygen')
# -- Function to get output of a command ----------------------------------
def run_cmd_get_output(cmd):
process = Popen(shlex.split(cmd), stdout=PIPE)
(output, err) = process.communicate()
exit_code = process.wait()
if exit_code != 0:
raise RuntimeError('command line program has failed')
return output
# -- General configuration ------------------------------------------------
@@ -64,10 +75,13 @@ copyright = u'2016, Espressif'
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# This is supposed to be "the short X.Y version", but it's the only version
# visible when you open index.html.
# Display full version to make things less confusing.
# If needed, nearest tag is returned by 'git describe --abbrev=0'.
version = run_cmd_get_output('git describe')
# The full version, including alpha/beta/rc tags.
release = '1.0'
release = run_cmd_get_output('git describe')
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.