Neutron integration with OVN
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

106 lines
3.4KB

  1. # -*- coding: utf-8 -*-
  2. # Licensed under the Apache License, Version 2.0 (the "License");
  3. # you may not use this file except in compliance with the License.
  4. # You may obtain a copy of the License at
  5. #
  6. # http://www.apache.org/licenses/LICENSE-2.0
  7. #
  8. # Unless required by applicable law or agreed to in writing, software
  9. # distributed under the License is distributed on an "AS IS" BASIS,
  10. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  11. # implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. import os
  15. import sys
  16. sys.path.insert(0, os.path.abspath('../..'))
  17. # -- General configuration ----------------------------------------------------
  18. # Add any Sphinx extension module names here, as strings. They can be
  19. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  20. extensions = [
  21. 'sphinx.ext.autodoc',
  22. #'sphinx.ext.intersphinx',
  23. 'openstackdocstheme',
  24. 'oslo_config.sphinxext',
  25. 'oslo_config.sphinxconfiggen',
  26. ]
  27. # openstackdocstheme options
  28. repository_name = 'openstack/networking-ovn'
  29. bug_project = 'networking-ovn'
  30. bug_tag = ''
  31. # autodoc generation is a bit aggressive and a nuisance when doing heavy
  32. # text edit cycles.
  33. # execute "export SPHINX_DEBUG=1" in your terminal to disable
  34. # The suffix of source filenames.
  35. source_suffix = '.rst'
  36. # The master toctree document.
  37. master_doc = 'index'
  38. # General information about the project.
  39. project = u'networking-ovn'
  40. # If true, '()' will be appended to :func: etc. cross-reference text.
  41. add_function_parentheses = True
  42. # If true, the current module name will be prepended to all description
  43. # unit titles (such as .. function::).
  44. add_module_names = True
  45. # The name of the Pygments (syntax highlighting) style to use.
  46. pygments_style = 'sphinx'
  47. # -- Options for HTML output --------------------------------------------------
  48. # The theme to use for HTML and HTML Help pages. Major themes that come with
  49. # Sphinx are currently 'default' and 'sphinxdoc'.
  50. # html_theme_path = ["."]
  51. # html_theme = '_theme'
  52. html_static_path = ['_static']
  53. html_theme = 'openstackdocs'
  54. html_last_updated_fmt = '%Y-%m-%d %H:%M'
  55. # Output file base name for HTML help builder.
  56. htmlhelp_basename = '%sdoc' % project
  57. # Grouping the document tree into LaTeX files. List of tuples
  58. # (source start file, target name, title, author, documentclass
  59. # [howto/manual]).
  60. latex_documents = [
  61. ('index',
  62. '%s.tex' % project,
  63. u'%s Documentation' % project,
  64. u'OpenStack Foundation', 'manual'),
  65. ]
  66. # Example configuration for intersphinx: refer to the Python standard library.
  67. #intersphinx_mapping = {'http://docs.python.org/': None}
  68. # -- Options for oslo_config.sphinxconfiggen ---------------------------------
  69. _config_generator_config_files = [
  70. 'ml2_conf.ini',
  71. 'networking_ovn_metadata_agent.ini',
  72. ]
  73. def _get_config_generator_config_definition(config_file):
  74. config_file_path = '../../etc/oslo-config-generator/%s' % config_file
  75. # oslo_config.sphinxconfiggen appends '.conf.sample' to the filename,
  76. # strip file extentension (.conf or .ini).
  77. output_file_path = '_static/config_samples/%s' % config_file.rsplit('.',
  78. 1)[0]
  79. return (config_file_path, output_file_path)
  80. config_generator_config_file = [
  81. _get_config_generator_config_definition(conf)
  82. for conf in _config_generator_config_files
  83. ]