mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-26 21:59:38 -07:00
5cac8efd73
The `webdocs` make target fails under Python 3. It fails due to a variety of syntax errors, such as the use of `except Foo, e` and `print 'foo'`. Fix #13463 by making code compatible with both Python 2 and 3.
97 lines
2.9 KiB
Python
Executable file
97 lines
2.9 KiB
Python
Executable file
#!/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 os
|
|
import sys
|
|
import traceback
|
|
try:
|
|
from sphinx.application import Sphinx
|
|
except ImportError:
|
|
print("#################################")
|
|
print("Dependency missing: Python Sphinx")
|
|
print("#################################")
|
|
sys.exit(1)
|
|
import os
|
|
|
|
|
|
class SphinxBuilder(object):
|
|
"""
|
|
Creates HTML documentation using Sphinx.
|
|
"""
|
|
|
|
def __init__(self):
|
|
"""
|
|
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
|
|
app = Sphinx(srcdir,
|
|
confdir,
|
|
outdir,
|
|
doctreedir,
|
|
buildername,
|
|
{},
|
|
sys.stdout,
|
|
sys.stderr,
|
|
freshenv)
|
|
|
|
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():
|
|
docgen = SphinxBuilder()
|
|
|
|
if __name__ == '__main__':
|
|
if '-h' in sys.argv or '--help' in sys.argv:
|
|
print("This script builds the html documentation from rst/asciidoc sources.\n")
|
|
print(" Run 'make docs' to build everything.")
|
|
print(" Run 'make viewdocs' to build and then preview in a web browser.")
|
|
sys.exit(0)
|
|
|
|
build_rst_docs()
|
|
|
|
if "view" in sys.argv:
|
|
import webbrowser
|
|
if not webbrowser.open('htmlout/index.html'):
|
|
print("Could not open on your webbrowser.", file=sys.stderr)
|