diff options
Diffstat (limited to 'docs/docsite/build-site.py')
-rwxr-xr-x | docs/docsite/build-site.py | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/docs/docsite/build-site.py b/docs/docsite/build-site.py new file mode 100755 index 0000000000..24991640df --- /dev/null +++ b/docs/docsite/build-site.py @@ -0,0 +1,111 @@ +#!/usr/bin/env python +# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com> +# +# This file is part of the Ansible Documentation +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see <http://www.gnu.org/licenses/>. +from __future__ import print_function + +__docformat__ = 'restructuredtext' + +import optparse +import os +import sys +import traceback +try: + from sphinx.application import Sphinx +except ImportError: + print("#################################") + print("Dependency missing: Python Sphinx") + print("#################################") + sys.exit(1) + + +class SphinxBuilder(object): + """ + Creates HTML documentation using Sphinx. + """ + + def __init__(self, verbosity=None, parallel=None): + """ + Run the DocCommand. + """ + print("Creating html documentation ...") + + try: + buildername = 'html' + + outdir = os.path.abspath(os.path.join(os.getcwd(), "htmlout")) + # Create the output directory if it doesn't exist + if not os.access(outdir, os.F_OK): + os.mkdir(outdir) + + doctreedir = os.path.join('./', '.doctrees') + + confdir = os.path.abspath('./') + srcdir = os.path.abspath('rst') + freshenv = True + + # Create the builder + # __init__(self, srcdir, confdir, outdir, doctreedir, buildername, confoverrides=None, status=<open file '<stdout>', mode 'w'>, warning=<open file '<stderr>', mode 'w'>, freshenv=False, warningiserror=False, tags=None, verbosity=0, parallel=0) + app = Sphinx(srcdir, + confdir, + outdir, + doctreedir, + buildername, + confoverrides={}, + status=sys.stdout, + warning=sys.stderr, + freshenv=freshenv, + verbosity=verbosity, + parallel=parallel) + + app.builder.build_all() + + except ImportError: + traceback.print_exc() + except Exception as ex: + print("FAIL! exiting ... (%s)" % ex, file=sys.stderr) + + def build_docs(self): + self.app.builder.build_all() + +def build_rst_docs(verbosity=None, parallel=None): + verbosity = verbosity or 1 + parallel = parallel or 1 + SphinxBuilder(verbosity=verbosity, + parallel=parallel) + +USAGE = """This script builds the html documentation from rst/asciidoc sources.\n") +Run 'make docs' to build everything.\n +Run 'make viewdocs' to build and then preview in a web browser.""" + +if __name__ == '__main__': + + parser = optparse.OptionParser(USAGE) + parser.add_option('-v','--verbose', dest='verbosity', default=0, action="count", + help="verbose mode (-vvv for more, -vvvv to enable connection debugging)") + parser.add_option('-j', '--parallel', dest='parallel', default="1", action='store', + help="Number of threads to start") + parser.add_option('--view', dest='view', + help="Open a browser after building docs") + + options, args = parser.parse_args(sys.argv[:]) + + build_rst_docs(verbosity=options.verbosity, parallel=int(options.parallel)) + + if hasattr(options, 'view'): + import webbrowser + if not webbrowser.open('htmlout/index.html'): + print("Could not open on your webbrowser.", file=sys.stderr) |