keystone  18.0.0
About: OpenStack Keystone (Core Service: Identity) provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services.
The "Victoria" series (maintained release).
  Fossies Dox: keystone-18.0.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

conf Namespace Reference

Variables

string html_theme = 'openstackdocs'
 
dictionary html_theme_options
 
list extensions
 
string source_suffix = '.rst'
 
string master_doc = 'index'
 
string copyright = u'2010-present, OpenStack Foundation'
 
string openstackdocs_repo_name = 'openstack/keystone'
 
string openstackdocs_bug_project = 'keystone'
 
string openstackdocs_bug_tag = 'api-ref'
 
bool add_module_names = False
 
bool show_authors = False
 
string pygments_style = 'native'
 
string htmlhelp_basename = 'keystonedoc'
 
string blockdiag_html_image_format = 'SVG'
 
string blockdiag_fontpath = 'DejaVuSans.ttf'
 
string apidoc_module_dir = '../../keystone'
 
string apidoc_output_dir = 'api'
 
list apidoc_excluded_paths
 
bool apidoc_separate_modules = True
 
bool seqdiag_antialias = True
 
string seqdiag_html_image_format = 'SVG'
 
string config_generator_config_file = '../../config-generator/keystone.conf'
 
string sample_config_basename = '_static/keystone'
 
tuple policy_generator_config_file
 
string sample_policy_basename = '_static/keystone'
 
bool todo_include_todos = True
 
list exclude_patterns = ['old']
 
list modindex_common_prefix = ['keystone.']
 
list man_pages
 
list html_static_path = ['_static']
 
bool latex_use_xindy = False
 
bool latex_domain_indices = False
 
dictionary latex_elements
 
list latex_documents
 
list texinfo_documents
 
list openstackdocs_projects = ['python-openstackclient']
 
bool openstackdocs_pdf_link = True
 
list templates_path = ['_templates']
 
string project = u'Keystone Release Notes'
 
string release = ''
 
string version = ''
 
list locale_dirs = ['locale/']
 
bool openstackdocs_auto_name = False
 

Variable Documentation

◆ add_module_names

bool conf.add_module_names = False

Definition at line 94 of file conf.py.

◆ apidoc_excluded_paths

list conf.apidoc_excluded_paths
Initial value:
1 = [
2  'tests/*',
3  'tests',
4  'test']

Definition at line 55 of file conf.py.

◆ apidoc_module_dir

string conf.apidoc_module_dir = '../../keystone'

Definition at line 53 of file conf.py.

◆ apidoc_output_dir

string conf.apidoc_output_dir = 'api'

Definition at line 54 of file conf.py.

◆ apidoc_separate_modules

bool conf.apidoc_separate_modules = True

Definition at line 59 of file conf.py.

◆ blockdiag_fontpath

string conf.blockdiag_fontpath = 'DejaVuSans.ttf'

Definition at line 50 of file conf.py.

◆ blockdiag_html_image_format

string conf.blockdiag_html_image_format = 'SVG'

Definition at line 48 of file conf.py.

◆ config_generator_config_file

string conf.config_generator_config_file = '../../config-generator/keystone.conf'

Definition at line 65 of file conf.py.

◆ copyright

string conf.copyright = u'2010-present, OpenStack Foundation'

Definition at line 64 of file conf.py.

◆ exclude_patterns

list conf.exclude_patterns = ['old']

Definition at line 99 of file conf.py.

◆ extensions

list conf.extensions
Initial value:
1 = [
2  'os_api_ref',
3  'openstackdocstheme',
4 ]

Definition at line 31 of file conf.py.

◆ html_static_path

list conf.html_static_path = ['_static']

Definition at line 166 of file conf.py.

◆ html_theme

string conf.html_theme = 'openstackdocs'

Definition at line 25 of file conf.py.

◆ html_theme_options

dictionary conf.html_theme_options
Initial value:
1 = {
2  "sidebar_dropdown": "api_ref",
3  "sidebar_mode": "toc",
4 }

Definition at line 26 of file conf.py.

◆ htmlhelp_basename

string conf.htmlhelp_basename = 'keystonedoc'

Definition at line 188 of file conf.py.

◆ latex_documents

list conf.latex_documents
Initial value:
1 = [
2  ('index', 'doc-keystone.tex', u'Keystone Documentation',
3  u'OpenStack', 'manual', True)
4 ]

Definition at line 228 of file conf.py.

◆ latex_domain_indices

bool conf.latex_domain_indices = False

Definition at line 214 of file conf.py.

◆ latex_elements

dictionary conf.latex_elements
Initial value:
1 = {
2  'makeindex': '',
3  'printindex': '',
4  'preamble': r'\setcounter{tocdepth}{3}',
5  'maxlistdepth': 10,
6 }

Definition at line 216 of file conf.py.

◆ latex_use_xindy

bool conf.latex_use_xindy = False

Definition at line 212 of file conf.py.

◆ locale_dirs

list conf.locale_dirs = ['locale/']

Definition at line 263 of file conf.py.

◆ man_pages

list conf.man_pages
Initial value:
1 = [
2  ('cli/keystone-manage', 'keystone-manage', u'Keystone Management Utility',
3  [u'OpenStack'], 1)
4 ]

Definition at line 127 of file conf.py.

◆ master_doc

string conf.master_doc = 'index'

Definition at line 61 of file conf.py.

◆ modindex_common_prefix

list conf.modindex_common_prefix = ['keystone.']

Definition at line 120 of file conf.py.

◆ openstackdocs_auto_name

bool conf.openstackdocs_auto_name = False

Definition at line 266 of file conf.py.

◆ openstackdocs_bug_project

string conf.openstackdocs_bug_project = 'keystone'

Definition at line 68 of file conf.py.

◆ openstackdocs_bug_tag

string conf.openstackdocs_bug_tag = 'api-ref'

Definition at line 69 of file conf.py.

◆ openstackdocs_pdf_link

bool conf.openstackdocs_pdf_link = True

Definition at line 283 of file conf.py.

◆ openstackdocs_projects

list conf.openstackdocs_projects = ['python-openstackclient']

Definition at line 282 of file conf.py.

◆ openstackdocs_repo_name

string conf.openstackdocs_repo_name = 'openstack/keystone'

Definition at line 67 of file conf.py.

◆ policy_generator_config_file

tuple conf.policy_generator_config_file
Initial value:
1 = (
2  '../../config-generator/keystone-policy-generator.conf'
3 )

Definition at line 68 of file conf.py.

◆ project

string conf.project = u'Keystone Release Notes'

Definition at line 57 of file conf.py.

◆ pygments_style

string conf.pygments_style = 'native'

Definition at line 101 of file conf.py.

◆ release

string conf.release = ''

Definition at line 64 of file conf.py.

◆ sample_config_basename

string conf.sample_config_basename = '_static/keystone'

Definition at line 66 of file conf.py.

◆ sample_policy_basename

string conf.sample_policy_basename = '_static/keystone'

Definition at line 71 of file conf.py.

◆ seqdiag_antialias

bool conf.seqdiag_antialias = True

Definition at line 62 of file conf.py.

◆ seqdiag_html_image_format

string conf.seqdiag_html_image_format = 'SVG'

Definition at line 63 of file conf.py.

◆ show_authors

bool conf.show_authors = False

Definition at line 98 of file conf.py.

◆ source_suffix

string conf.source_suffix = '.rst'

Definition at line 55 of file conf.py.

◆ templates_path

list conf.templates_path = ['_templates']

Definition at line 45 of file conf.py.

◆ texinfo_documents

list conf.texinfo_documents
Initial value:
1 = [
2  ('index', 'keystone', u'Keystone Documentation',
3  u'OpenStack', 'keystone', 'One line description of project.',
4  'Miscellaneous'),
5 ]

Definition at line 259 of file conf.py.

◆ todo_include_todos

bool conf.todo_include_todos = True

Definition at line 73 of file conf.py.

◆ version

string conf.version = ''

Definition at line 66 of file conf.py.