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.

208 lines
7.0 KiB

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Tendermint documentation build configuration file, created by
  4. # sphinx-quickstart on Mon Aug 7 04:55:09 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. import urllib
  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. # Add any paths that contain templates here, relative to this directory.
  32. templates_path = ['_templates']
  33. # The suffix(es) of source filenames.
  34. # You can specify multiple suffix as a list of string:
  35. #
  36. #source_suffix = ['.rst', '.md']
  37. source_suffix = '.rst'
  38. # The master toctree document.
  39. master_doc = 'index'
  40. # General information about the project.
  41. project = u'Tendermint'
  42. copyright = u'2018, The Authors'
  43. author = u'Tendermint'
  44. # The version info for the project you're documenting, acts as replacement for
  45. # |version| and |release|, also used in various other places throughout the
  46. # built documents.
  47. #
  48. # The short X.Y version.
  49. version = u''
  50. # The full version, including alpha/beta/rc tags.
  51. release = u''
  52. # The language for content autogenerated by Sphinx. Refer to documentation
  53. # for a list of supported languages.
  54. #
  55. # This is also used if you do content translation via gettext catalogs.
  56. # Usually you set "language" from the command line for these cases.
  57. language = None
  58. # List of patterns, relative to source directory, that match files and
  59. # directories to ignore when looking for source files.
  60. # This patterns also effect to html_static_path and html_extra_path
  61. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'architecture', 'specification/new-spec', 'examples']
  62. # The name of the Pygments (syntax highlighting) style to use.
  63. pygments_style = 'sphinx'
  64. # If true, `todo` and `todoList` produce output, else they produce nothing.
  65. todo_include_todos = False
  66. # -- Options for HTML output ----------------------------------------------
  67. # The theme to use for HTML and HTML Help pages. See the documentation for
  68. # a list of builtin themes.
  69. #
  70. html_theme = 'sphinx_rtd_theme'
  71. # html_theme = 'alabaster'
  72. # Theme options are theme-specific and customize the look and feel of a theme
  73. # further. For a list of options available for each theme, see the
  74. # documentation.
  75. #
  76. # html_theme_options = {}
  77. # Add any paths that contain custom static files (such as style sheets) here,
  78. # relative to this directory. They are copied after the builtin static files,
  79. # so a file named "default.css" will overwrite the builtin "default.css".
  80. html_static_path = ['_static']
  81. # Custom sidebar templates, must be a dictionary that maps document names
  82. # to template names.
  83. #
  84. # This is required for the alabaster theme
  85. # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
  86. html_sidebars = {
  87. '**': [
  88. 'about.html',
  89. 'navigation.html',
  90. 'relations.html', # needs 'show_related': True theme option to display
  91. 'searchbox.html',
  92. 'donate.html',
  93. ]
  94. }
  95. # -- Options for HTMLHelp output ------------------------------------------
  96. # Output file base name for HTML help builder.
  97. htmlhelp_basename = 'Tendermintdoc'
  98. # -- Options for LaTeX output ---------------------------------------------
  99. latex_elements = {
  100. # The paper size ('letterpaper' or 'a4paper').
  101. #
  102. # 'papersize': 'letterpaper',
  103. # The font size ('10pt', '11pt' or '12pt').
  104. #
  105. # 'pointsize': '10pt',
  106. # Additional stuff for the LaTeX preamble.
  107. #
  108. # 'preamble': '',
  109. # Latex figure (float) alignment
  110. #
  111. # 'figure_align': 'htbp',
  112. }
  113. # Grouping the document tree into LaTeX files. List of tuples
  114. # (source start file, target name, title,
  115. # author, documentclass [howto, manual, or own class]).
  116. latex_documents = [
  117. (master_doc, 'Tendermint.tex', u'Tendermint Documentation',
  118. u'The Authors', 'manual'),
  119. ]
  120. # -- Options for manual page output ---------------------------------------
  121. # One entry per manual page. List of tuples
  122. # (source start file, name, description, authors, manual section).
  123. man_pages = [
  124. (master_doc, 'Tendermint', u'Tendermint Documentation',
  125. [author], 1)
  126. ]
  127. # -- Options for Texinfo output -------------------------------------------
  128. # Grouping the document tree into Texinfo files. List of tuples
  129. # (source start file, target name, title, author,
  130. # dir menu entry, description, category)
  131. texinfo_documents = [
  132. (master_doc, 'Tendermint', u'Tendermint Documentation',
  133. author, 'Tendermint', 'Byzantine Fault Tolerant Consensus.',
  134. 'Database'),
  135. ]
  136. # ---- customization -------------------------
  137. tools_repo = "https://raw.githubusercontent.com/tendermint/tools/"
  138. tools_branch = "master"
  139. tools_dir = "./tools"
  140. assets_dir = tools_dir + "/assets"
  141. if os.path.isdir(tools_dir) != True:
  142. os.mkdir(tools_dir)
  143. if os.path.isdir(assets_dir) != True:
  144. os.mkdir(assets_dir)
  145. urllib.urlretrieve(tools_repo+tools_branch+'/ansible/README.rst', filename=tools_dir+'/ansible.rst')
  146. urllib.urlretrieve(tools_repo+tools_branch+'/ansible/assets/a_plus_t.png', filename=assets_dir+'/a_plus_t.png')
  147. urllib.urlretrieve(tools_repo+tools_branch+'/docker/README.rst', filename=tools_dir+'/docker.rst')
  148. urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/README.rst', filename=tools_dir+'/mintnet-kubernetes.rst')
  149. urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/gce1.png', filename=assets_dir+'/gce1.png')
  150. urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/gce2.png', filename=assets_dir+'/gce2.png')
  151. urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/statefulset.png', filename=assets_dir+'/statefulset.png')
  152. urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/t_plus_k.png', filename=assets_dir+'/t_plus_k.png')
  153. urllib.urlretrieve(tools_repo+tools_branch+'/terraform-digitalocean/README.rst', filename=tools_dir+'/terraform-digitalocean.rst')
  154. urllib.urlretrieve(tools_repo+tools_branch+'/tm-bench/README.rst', filename=tools_dir+'/benchmarking-and-monitoring.rst')
  155. # the readme for below is included in tm-bench
  156. # urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/tm-monitor/README.rst', filename='tools/tm-monitor.rst')
  157. #### abci spec #################################
  158. abci_repo = "https://raw.githubusercontent.com/tendermint/abci/"
  159. abci_branch = "develop"
  160. urllib.urlretrieve(abci_repo+abci_branch+'/specification.rst', filename='abci-spec.rst')