conf.py 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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. ]
  24. # autodoc generation is a bit aggressive and a nuisance when doing heavy
  25. # text edit cycles.
  26. # execute "export SPHINX_DEBUG=1" in your terminal to disable
  27. # The suffix of source filenames.
  28. source_suffix = '.rst'
  29. # The master toctree document.
  30. master_doc = 'index'
  31. # General information about the project.
  32. project = u'testpackage'
  33. copyright = u'2013, OpenStack Foundation'
  34. # If true, '()' will be appended to :func: etc. cross-reference text.
  35. add_function_parentheses = True
  36. # If true, the current module name will be prepended to all description
  37. # unit titles (such as .. function::).
  38. add_module_names = True
  39. # The name of the Pygments (syntax highlighting) style to use.
  40. pygments_style = 'sphinx'
  41. # -- Options for HTML output --------------------------------------------------
  42. # The theme to use for HTML and HTML Help pages. Major themes that come with
  43. # Sphinx are currently 'default' and 'sphinxdoc'.
  44. # html_theme_path = ["."]
  45. # html_theme = '_theme'
  46. # html_static_path = ['static']
  47. # Output file base name for HTML help builder.
  48. htmlhelp_basename = '%sdoc' % project
  49. # Grouping the document tree into LaTeX files. List of tuples
  50. # (source start file, target name, title, author, documentclass
  51. # [howto/manual]).
  52. latex_documents = [
  53. ('index',
  54. '%s.tex' % project,
  55. u'%s Documentation' % project,
  56. u'OpenStack Foundation', 'manual'),
  57. ]
  58. # Example configuration for intersphinx: refer to the Python standard library.
  59. #intersphinx_mapping = {'http://docs.python.org/': None}