conf.py 5.6 KB

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