src/ceph/doc/conf.py

   1 import sys
   2 import os
   3
   4 project = u'Ceph'
   5 copyright = u'2016, Red Hat, Inc, and contributors. Licensed under Creative Commons BY-SA'
   6 version = 'dev'
   7 release = 'dev'
   8
   9 templates_path = ['_templates']
  10 source_suffix = '.rst'
  11 master_doc = 'index'
  12 exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst']
  13 if tags.has('man'):
  14     exclude_patterns += ['architecture.rst', 'glossary.rst', 'release*.rst',
  15                          'api/*',
  16                          'cephfs/*',
  17                          'dev/*',
  18                          'install/*',
  19                          'mon/*',
  20                          'rados/*',
  21                          'mgr/*',
  22                          'ceph-volume/*',
  23                          'radosgw/*',
  24                          'rbd/*',
  25                          'start/*']
  26
  27 pygments_style = 'sphinx'
  28
  29 html_theme = 'ceph'
  30 html_theme_path = ['_themes']
  31 html_title = "Ceph Documentation"
  32 html_logo = 'logo.png'
  33 html_favicon = 'favicon.ico'
  34 html_use_smartypants = True
  35 html_show_sphinx = False
  36 html_sidebars = {
  37     '**': ['smarttoc.html', 'searchbox.html'],
  38     }
  39
  40 extensions = [
  41     'sphinx.ext.autodoc',
  42     'sphinx.ext.graphviz',
  43     'sphinx.ext.todo',
  44     'sphinxcontrib.ditaa',
  45     'breathe',
  46     ]
  47 ditaa = 'ditaa'
  48 todo_include_todos = True
  49
  50 top_level = os.path.dirname(
  51     os.path.dirname(
  52         os.path.abspath(__file__)
  53     )
  54 )
  55
  56 breathe_default_project = "Ceph"
  57 # see $(top_srcdir)/Doxyfile
  58
  59 breathe_build_directory = os.path.join(top_level, "build-doc")
  60 breathe_projects = {"Ceph": os.path.join(top_level, breathe_build_directory)}
  61 breathe_projects_source = {
  62     "Ceph": (os.path.join(top_level, "src/include/rados"),
  63              ["rados_types.h", "librados.h"])
  64 }
  65 breathe_domain_by_extension = {'py': 'py', 'c': 'c', 'h': 'c', 'cc': 'cxx', 'hpp': 'cxx'}
  66 pybind = os.path.join(top_level, 'src/pybind')
  67 if pybind not in sys.path:
  68     sys.path.insert(0, pybind)