conf.py 6.5 KB

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