Exemple #1
0
# Additional stuff for the LaTeX preamble.
# latex_preamble = ''

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True

# -- Options for manual page output --------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'buildbot', u'Buildbot Documentation',
              [u'Brian Warner'], 1)]

jinja_contexts = {"data_api": {'raml': RamlSpec()}}

# Spell checker.
try:
    import enchant  # noqa # pylint: disable=unused-import
except ImportError as ex:
    print("enchant module import failed:\n"
          "{0}\n"
          "Spell checking disabled.".format(ex),
          file=sys.stderr)

else:
    extensions.append('sphinxcontrib.spelling')
    spelling_show_suggestions = True
Exemple #2
0
# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True

# -- Options for manual page output --------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'buildbot', u'Buildbot Documentation',
              [u'Brian Warner'], 1)]

jinja_contexts = {
    "data_api": {
        'raml': RamlSpec()
    },
    "telegram": {
        'commands': TelegramContact.describe_commands()
    },
}

raml_spec = RamlSpec()
for raml_typename, raml_type in sorted(raml_spec.types.items()):
    jinja_contexts['data_api_' + raml_typename] = {
        'raml': raml_spec,
        'name': raml_typename,
        'type': raml_type,
    }

    doc_path = 'developer/raml/{}.rst'.format(raml_typename)
Exemple #3
0
# If false, no module index is generated.
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'buildbot', u'Buildbot Documentation',
     [u'Brian Warner'], 1)
]

jinja_contexts = {
    "data_api": {'raml': RamlSpec()}
}

# Spell checker.
try:
    import enchant  # noqa # pylint: disable=unused-import
except ImportError as ex:
    print("enchant module import failed:\n"
          "{0}\n"
          "Spell checking disabled.".format(ex),
          file=sys.stderr)

else:
    extensions.append('sphinxcontrib.spelling')
    spelling_show_suggestions = True
Exemple #4
0
# If false, no module index is generated.
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'buildbot', u'Buildbot Documentation',
     [u'Brian Warner'], 1)
]

jinja_contexts = {
    "data_api": {'raml': RamlSpec()},
    "telegram": {'commands': TelegramContact.describe_commands()},
}

raml_spec = RamlSpec()
for raml_typename, raml_type in sorted(raml_spec.types.items()):
    jinja_contexts['data_api_' + raml_typename] = {
        'raml': raml_spec,
        'name': raml_typename,
        'type': raml_type,
    }

    doc_path = 'developer/raml/{}.rst'.format(raml_typename)
    if not os.path.exists(doc_path):
        raise Exception('File {} for RAML type {} does not exist'.format(doc_path, raml_typename))
Exemple #5
0
# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True

# -- Options for manual page output --------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'buildbot', u'Buildbot Documentation',
              [u'Brian Warner'], 1)]

jinja_contexts = {
    "data_api": {
        'raml': RamlSpec()
    },
    "telegram": {
        'commands': TelegramContact.describe_commands()
    },
}

# Spell checker.
try:
    import enchant  # noqa # pylint: disable=unused-import
except ImportError as ex:
    print("enchant module import failed:\n"
          "{0}\n"
          "Spell checking disabled.".format(ex),
          file=sys.stderr)