conf.py 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Configuration file for the Sphinx documentation builder.
  4. #
  5. # This file does only contain a selection of the most common options. For a
  6. # full list see the documentation:
  7. # http://www.sphinx-doc.org/en/master/config
  8. # -- Path setup --------------------------------------------------------------
  9. # If extensions (or modules to document with autodoc) are in another directory,
  10. # add these directories to sys.path here. If the directory is relative to the
  11. # documentation root, use os.path.abspath to make it absolute, like shown here.
  12. #
  13. import os
  14. import sys
  15. sys.path.insert(0, os.path.abspath('../../../macop'))
  16. # -- Project information -----------------------------------------------------
  17. project = 'macop'
  18. copyright = '2020, Jérôme BUISINE'
  19. author = 'Jérôme BUISINE'
  20. # The short X.Y version
  21. version = '1.0.0'
  22. # The full version, including alpha/beta/rc tags
  23. release = 'v1.0.0'
  24. # -- General configuration ---------------------------------------------------
  25. # If your documentation needs a minimal Sphinx version, state it here.
  26. #
  27. # needs_sphinx = '1.0'
  28. # Add any Sphinx extension module names here, as strings. They can be
  29. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  30. # ones.
  31. extensions = [
  32. 'sphinx.ext.autodoc',
  33. 'sphinx.ext.doctest',
  34. 'sphinx.ext.coverage',
  35. 'sphinx.ext.napoleon',
  36. 'sphinx.ext.autosummary',
  37. 'sphinx.ext.viewcode',
  38. 'sphinx.ext.coverage',
  39. #'autoapi.extension'
  40. ]
  41. # autoapi_add_toctree_entry = True
  42. # autoapi_template_dir = '_autoapi_templates'
  43. # autoapi_dirs = ['../../rawls']
  44. autosummary_generate = True
  45. autodoc_default_flags = ['members']
  46. autodoc_member_order = 'groupwise'
  47. # Add any paths that contain templates here, relative to this directory.
  48. templates_path = ['_templates']
  49. # The suffix(es) of source filenames.
  50. # You can specify multiple suffix as a list of string:
  51. #
  52. # source_suffix = ['.rst', '.md']
  53. source_suffix = '.rst'
  54. # The master toctree document.
  55. master_doc = 'index'
  56. # The language for content autogenerated by Sphinx. Refer to documentation
  57. # for a list of supported languages.
  58. #
  59. # This is also used if you do content translation via gettext catalogs.
  60. # Usually you set "language" from the command line for these cases.
  61. language = None
  62. # List of patterns, relative to source directory, that match files and
  63. # directories to ignore when looking for source files.
  64. # This pattern also affects html_static_path and html_extra_path.
  65. exclude_patterns = []
  66. # The name of the Pygments (syntax highlighting) style to use.
  67. pygments_style = None
  68. # -- Options for HTML output -------------------------------------------------
  69. # The theme to use for HTML and HTML Help pages. See the documentation for
  70. # a list of builtin themes.
  71. #
  72. html_theme = 'sphinx_rtd_theme'
  73. # Theme options are theme-specific and customize the look and feel of a theme
  74. # further. For a list of options available for each theme, see the
  75. # documentation.
  76. #
  77. # html_theme_options = {}
  78. html_theme_options = {
  79. 'canonical_url': '',
  80. #'analytics_id': 'UA-XXXXXXX-1',
  81. 'logo_only': False,
  82. 'display_version': True,
  83. 'prev_next_buttons_location': 'bottom',
  84. 'style_external_links': False,
  85. #'vcs_pageview_mode': '',
  86. # Toc options
  87. 'collapse_navigation': True,
  88. 'sticky_navigation': True,
  89. 'navigation_depth': 4,
  90. 'includehidden': True,
  91. 'titles_only': False
  92. }
  93. html_context = {
  94. 'display_github': True,
  95. 'github_user': 'prise-3d',
  96. 'github_repo': 'macop',
  97. 'github_version': 'master/docs/source/'
  98. }
  99. # Add any paths that contain custom static files (such as style sheets) here,
  100. # relative to this directory. They are copied after the builtin static files,
  101. # so a file named "default.css" will overwrite the builtin "default.css".
  102. html_static_path = ['_static']
  103. # Custom sidebar templates, must be a dictionary that maps document names
  104. # to template names.
  105. #
  106. # The default sidebars (for documents that don't match any pattern) are
  107. # defined by theme itself. Builtin themes are using these templates by
  108. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  109. # 'searchbox.html']``.
  110. #
  111. # html_sidebars = {}
  112. # -- Options for HTMLHelp output ---------------------------------------------
  113. # Output file base name for HTML help builder.
  114. htmlhelp_basename = 'macopdoc'
  115. # -- Options for LaTeX output ------------------------------------------------
  116. latex_elements = {
  117. # The paper size ('letterpaper' or 'a4paper').
  118. #
  119. # 'papersize': 'letterpaper',
  120. # The font size ('10pt', '11pt' or '12pt').
  121. #
  122. # 'pointsize': '10pt',
  123. # Additional stuff for the LaTeX preamble.
  124. #
  125. # 'preamble': '',
  126. # Latex figure (float) alignment
  127. #
  128. # 'figure_align': 'htbp',
  129. }
  130. # Grouping the document tree into LaTeX files. List of tuples
  131. # (source start file, target name, title,
  132. # author, documentclass [howto, manual, or own class]).
  133. latex_documents = [
  134. (master_doc, 'macop.tex', 'macop Documentation',
  135. 'Jérôme BUISINE', 'manual'),
  136. ]
  137. # -- Options for manual page output ------------------------------------------
  138. # One entry per manual page. List of tuples
  139. # (source start file, name, description, authors, manual section).
  140. man_pages = [
  141. (master_doc, 'macop', 'macop Documentation',
  142. [author], 1)
  143. ]
  144. # -- Options for Texinfo output ----------------------------------------------
  145. # Grouping the document tree into Texinfo files. List of tuples
  146. # (source start file, target name, title, author,
  147. # dir menu entry, description, category)
  148. texinfo_documents = [
  149. (master_doc, 'macop', 'macop Documentation',
  150. author, 'macop', 'Minimalist And Customisable Optimisation Package',
  151. 'Miscellaneous'),
  152. ]
  153. # -- Options for Epub output -------------------------------------------------
  154. # Bibliographic Dublin Core info.
  155. epub_title = project
  156. # The unique identifier of the text. This can be a ISBN number
  157. # or the project homepage.
  158. #
  159. # epub_identifier = ''
  160. # A unique identification for the text.
  161. #
  162. # epub_uid = ''
  163. # A list of files that should not be packed into the epub file.
  164. epub_exclude_files = ['search.html']
  165. # -- Extension configuration -------------------------------------------------