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.

187 lines
5.5 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. #
  4. # python-keycloak documentation build configuration file, created by
  5. # sphinx-quickstart on Tue Aug 15 11:02:59 2017.
  6. #
  7. # This file is execfile()d with the current directory set to its
  8. # containing dir.
  9. #
  10. # Note that not all possible configuration values are present in this
  11. # autogenerated file.
  12. #
  13. # All configuration values have a default; values that are commented out
  14. # serve to show the default.
  15. # If extensions (or modules to document with autodoc) are in another directory,
  16. # add these directories to sys.path here. If the directory is relative to the
  17. # documentation root, use os.path.abspath to make it absolute, like shown here.
  18. #
  19. # import os
  20. # import sys
  21. # sys.path.insert(0, os.path.abspath('.'))
  22. import sphinx_rtd_theme
  23. # -- General configuration ------------------------------------------------
  24. # If your documentation needs a minimal Sphinx version, state it here.
  25. #
  26. # needs_sphinx = '1.0'
  27. # Add any Sphinx extension module names here, as strings. They can be
  28. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  29. # ones.
  30. extensions = [
  31. 'sphinx.ext.autodoc',
  32. 'sphinx.ext.intersphinx',
  33. 'sphinx.ext.todo',
  34. 'sphinx.ext.viewcode',
  35. ]
  36. # Add any paths that contain templates here, relative to this directory.
  37. templates_path = ['_templates']
  38. # The suffix(es) of source filenames.
  39. # You can specify multiple suffix as a list of string:
  40. #
  41. # source_suffix = ['.rst', '.md']
  42. source_suffix = '.rst'
  43. # The master toctree document.
  44. master_doc = 'index'
  45. # General information about the project.
  46. project = 'python-keycloak'
  47. copyright = '2017, Marcos Pereira'
  48. author = 'Marcos Pereira'
  49. # The version info for the project you're documenting, acts as replacement for
  50. # |version| and |release|, also used in various other places throughout the
  51. # built documents.
  52. #
  53. # The short X.Y version.
  54. version = '0.6.2'
  55. # The full version, including alpha/beta/rc tags.
  56. release = '0.6.2'
  57. # The language for content autogenerated by Sphinx. Refer to documentation
  58. # for a list of supported languages.
  59. #
  60. # This is also used if you do content translation via gettext catalogs.
  61. # Usually you set "language" from the command line for these cases.
  62. language = None
  63. # List of patterns, relative to source directory, that match files and
  64. # directories to ignore when looking for source files.
  65. # This patterns also effect to html_static_path and html_extra_path
  66. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  67. add_function_parentheses = False
  68. add_module_names = True
  69. # The name of the Pygments (syntax highlighting) style to use.
  70. pygments_style = 'sphinx'
  71. # If true, `todo` and `todoList` produce output, else they produce nothing.
  72. todo_include_todos = True
  73. # -- Options for HTML output ----------------------------------------------
  74. # The theme to use for HTML and HTML Help pages. See the documentation for
  75. # a list of builtin themes.
  76. #
  77. html_theme = 'sphinx_rtd_theme'
  78. html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
  79. # Theme options are theme-specific and customize the look and feel of a theme
  80. # further. For a list of options available for each theme, see the
  81. # documentation.
  82. #
  83. # html_theme_options = {}
  84. # Add any paths that contain custom static files (such as style sheets) here,
  85. # relative to this directory. They are copied after the builtin static files,
  86. # so a file named "default.css" will overwrite the builtin "default.css".
  87. html_static_path = ['_static']
  88. html_use_smartypants = False
  89. html_show_sourcelink = False
  90. html_show_sphinx = False
  91. html_show_copyright = True
  92. # Custom sidebar templates, must be a dictionary that maps document names
  93. # to template names.
  94. #
  95. # This is required for the alabaster theme
  96. # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
  97. #html_sidebars = {
  98. # '**': [
  99. # 'about.html',
  100. # 'navigation.html',
  101. # 'relations.html', # needs 'show_related': True theme option to display
  102. # 'searchbox.html',
  103. # 'donate.html',
  104. # ]
  105. #}
  106. # -- Options for HTMLHelp output ------------------------------------------
  107. # Output file base name for HTML help builder.
  108. htmlhelp_basename = 'python-keycloakdoc'
  109. # -- Options for LaTeX output ---------------------------------------------
  110. latex_elements = {
  111. # The paper size ('letterpaper' or 'a4paper').
  112. #
  113. # 'papersize': 'letterpaper',
  114. # The font size ('10pt', '11pt' or '12pt').
  115. #
  116. # 'pointsize': '10pt',
  117. # Additional stuff for the LaTeX preamble.
  118. #
  119. # 'preamble': '',
  120. # Latex figure (float) alignment
  121. #
  122. # 'figure_align': 'htbp',
  123. }
  124. # Grouping the document tree into LaTeX files. List of tuples
  125. # (source start file, target name, title,
  126. # author, documentclass [howto, manual, or own class]).
  127. latex_documents = [
  128. (master_doc, 'python-keycloak.tex', 'python-keycloak Documentation',
  129. 'Marcos Pereira', 'manual'),
  130. ]
  131. # -- Options for manual page output ---------------------------------------
  132. # One entry per manual page. List of tuples
  133. # (source start file, name, description, authors, manual section).
  134. man_pages = [
  135. (master_doc, 'python-keycloak', 'python-keycloak Documentation',
  136. [author], 1)
  137. ]
  138. # -- Options for Texinfo output -------------------------------------------
  139. # Grouping the document tree into Texinfo files. List of tuples
  140. # (source start file, target name, title, author,
  141. # dir menu entry, description, category)
  142. texinfo_documents = [
  143. (master_doc, 'python-keycloak', 'python-keycloak Documentation',
  144. author, 'python-keycloak', 'One line description of project.',
  145. 'Miscellaneous'),
  146. ]