Tools used by OpenStack Documentation
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.

95 lines
3.1KB

  1. # Licensed under the Apache License, Version 2.0 (the "License");
  2. # you may not use this file except in compliance with the License.
  3. # You may obtain a copy of the License at
  4. #
  5. # http://www.apache.org/licenses/LICENSE-2.0
  6. #
  7. # Unless required by applicable law or agreed to in writing, software
  8. # distributed under the License is distributed on an "AS IS" BASIS,
  9. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  10. # implied.
  11. # See the License for the specific language governing permissions and
  12. # limitations under the License.
  13. import os
  14. import sys
  15. sys.path.insert(0, os.path.abspath('../..'))
  16. # -- General configuration ----------------------------------------------------
  17. # Add any Sphinx extension module names here, as strings. They can be
  18. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  19. extensions = [
  20. 'sphinx.ext.autodoc',
  21. 'openstackdocstheme'
  22. ]
  23. # autodoc generation is a bit aggressive and a nuisance when doing heavy
  24. # text edit cycles.
  25. # execute "export SPHINX_DEBUG=1" in your terminal to disable
  26. # The suffix of source filenames.
  27. source_suffix = '.rst'
  28. # The master toctree document.
  29. master_doc = 'index'
  30. # General information about the project.
  31. repository_name = 'openstack/openstack-doc-tools'
  32. bug_tag = u'openstack-doc-tools'
  33. project = u'OpenStack-doc-tools'
  34. copyright = u'2017, OpenStack Foundation'
  35. # If true, '()' will be appended to :func: etc. cross-reference text.
  36. add_function_parentheses = True
  37. # If true, the current module name will be prepended to all description
  38. # unit titles (such as .. function::).
  39. add_module_names = True
  40. # The name of the Pygments (syntax highlighting) style to use.
  41. pygments_style = 'sphinx'
  42. # -- Options for HTML output --------------------------------------------------
  43. # The theme to use for HTML and HTML Help pages. See the documentation for
  44. # a list of builtin themes.
  45. html_theme = 'openstackdocs'
  46. # Add any paths that contain custom themes here, relative to this directory.
  47. # html_theme_path = [openstackdocstheme.get_html_theme_path()]
  48. # html_static_path = ['static']
  49. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  50. # using the given strftime format.
  51. # So that we can enable "log-a-bug" links from each output HTML page, this
  52. # variable must be set to a format that includes year, month, day, hours and
  53. # minutes.
  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 manual page output -------------------------------------------
  69. # One entry per manual page. List of tuples
  70. # (source start file, name, description, authors, manual section).
  71. man_pages = []
  72. # If true, show URL addresses after external links.
  73. # man_show_urls = False