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.

175 lines
5.0KB

  1. # Configuration file for the Sphinx documentation builder.
  2. #
  3. # This file only contains a selection of the most common options. For a full
  4. # list see the documentation:
  5. # https://www.sphinx-doc.org/en/master/usage/configuration.html
  6. # -- Path setup --------------------------------------------------------------
  7. # If extensions (or modules to document with autodoc) are in another directory,
  8. # add these directories to sys.path here. If the directory is relative to the
  9. # documentation root, use os.path.abspath to make it absolute, like shown here.
  10. #
  11. # import os
  12. # import sys
  13. # sys.path.insert(0, os.path.abspath('.'))
  14. # -- Project information -----------------------------------------------------
  15. project = 'DERO Documentation'
  16. copyright = '2020, DERO Foundation'
  17. author = 'DERO Foundation'
  18. # -- General configuration ---------------------------------------------------
  19. # Add any Sphinx extension module names here, as strings. They can be
  20. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  21. # ones.
  22. extensions = [
  23. 'recommonmark'
  24. 'sphinx.ext.imgmath'
  25. 'sphinx.ext.githubpages'
  26. 'rst2pdf.pdfbuilder'
  27. ]
  28. pdf_documents = [('index', u'pdf name', u'Sample doc Title', u'author name')]
  29. # Add any paths that contain templates here, relative to this directory.
  30. templates_path = ['_templates']
  31. # The suffix(es) of source filenames.
  32. # You can specify multiple suffix as a list of string:
  33. #
  34. # source_suffix = ['.rst', '.md']
  35. source_suffix = '.rst'
  36. # The master toctree document.
  37. master_doc = 'index'
  38. # The language for content autogenerated by Sphinx. Refer to documentation
  39. # for a list of supported languages.
  40. #
  41. # This is also used if you do content translation via gettext catalogs.
  42. # Usually you set "language" from the command line for these cases.
  43. language = None
  44. # List of patterns, relative to source directory, that match files and
  45. # directories to ignore when looking for source files.
  46. # This pattern also affects html_static_path and html_extra_path.
  47. exclude_patterns = []
  48. # -- Options for HTML output -------------------------------------------------
  49. # The theme to use for HTML and HTML Help pages. See the documentation for
  50. # a list of builtin themes.
  51. #
  52. html_theme = 'sphinx_rtd_theme'
  53. import sphinx_fontawesome
  54. extensions = ['sphinx_fontawesome']
  55. # Theme options are theme-specific and customize the look and feel of a theme
  56. # further. For a list of options available for each theme, see the
  57. # documentation.
  58. #
  59. # html_theme_options = {}
  60. html_theme_options = {
  61. # if we have a html_logo below, this shows /only/ the logo with no title text
  62. "logo_only": True,
  63. # Collapse navigation (False makes it tree-like)
  64. "collapse_navigation": False,
  65. }
  66. html_logo = "img/docs_logo.png"
  67. # Add any paths that contain custom static files (such as style sheets) here,
  68. # relative to this directory. They are copied after the builtin static files,
  69. # so a file named "default.css" will overwrite the builtin "default.css".
  70. html_static_path = ['_static']
  71. html_css_files = [
  72. "css/custom.css",
  73. ]
  74. # -- Options for HTMLHelp output ---------------------------------------------
  75. # Output file base name for HTML help builder.
  76. htmlhelp_basename = 'DEROdoc'
  77. # -- Options for LaTeX output ------------------------------------------------
  78. latex_elements = {
  79. # The paper size ('letterpaper' or 'a4paper').
  80. #
  81. # 'papersize': 'letterpaper',
  82. # The font size ('10pt', '11pt' or '12pt').
  83. #
  84. # 'pointsize': '10pt',
  85. # Additional stuff for the LaTeX preamble.
  86. #
  87. # 'preamble': '',
  88. # Latex figure (float) alignment
  89. #
  90. # 'figure_align': 'htbp',
  91. }
  92. # Grouping the document tree into LaTeX files. List of tuples
  93. # (source start file, target name, title,
  94. # author, documentclass [howto, manual, or own class]).
  95. latex_documents = [
  96. (master_doc, 'DERO.tex', 'DERO Documentation',
  97. 'DERO Foundation', 'manual'),
  98. ]
  99. # -- Options for manual page output ------------------------------------------
  100. # One entry per manual page. List of tuples
  101. # (source start file, name, description, authors, manual section).
  102. man_pages = [
  103. (master_doc, 'DERO', 'DERO Documentation',
  104. [author], 1)
  105. ]
  106. # -- Options for Texinfo output ----------------------------------------------
  107. # Grouping the document tree into Texinfo files. List of tuples
  108. # (source start file, target name, title, author,
  109. # dir menu entry, description, category)
  110. texinfo_documents = [
  111. (master_doc, 'DERO', 'DERO Documentation',
  112. author, 'DERO Foundation', 'One line description of project.',
  113. 'DERO Foundation'),
  114. ]
  115. # -- Options for Epub output -------------------------------------------------
  116. # Bibliographic Dublin Core info.
  117. epub_title = project
  118. # The unique identifier of the text. This can be a ISBN number
  119. # or the project homepage.
  120. #
  121. # epub_identifier = ''
  122. # A unique identification for the text.
  123. #
  124. # epub_uid = ''
  125. # A list of files that should not be packed into the epub file.
  126. epub_exclude_files = ['search.html']
  127. html_favicon = 'favicon.ico'
  128. # -- Extension configuration -------------------------------------------------