conf.py 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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('../../ipfml'))
  16. # -- Project information -----------------------------------------------------
  17. project = 'IPFML'
  18. copyright = '2019, Jérôme BUISINE'
  19. author = 'Jérôme BUISINE'
  20. # The short X.Y version
  21. version = '0.3.6'
  22. # The full version, including alpha/beta/rc tags
  23. release = 'v0.3.6'
  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. ]
  40. autosummary_generate = True
  41. autodoc_default_flags = ['members']
  42. autodoc_member_order = 'groupwise'
  43. # Add any paths that contain templates here, relative to this directory.
  44. templates_path = ['_templates']
  45. # The suffix(es) of source filenames.
  46. # You can specify multiple suffix as a list of string:
  47. #
  48. # source_suffix = ['.rst', '.md']
  49. source_suffix = '.rst'
  50. # The master toctree document.
  51. master_doc = 'index'
  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 pattern also affects html_static_path and html_extra_path.
  61. exclude_patterns = []
  62. # The name of the Pygments (syntax highlighting) style to use.
  63. pygments_style = None
  64. # -- Options for HTML output -------------------------------------------------
  65. # The theme to use for HTML and HTML Help pages. See the documentation for
  66. # a list of builtin themes.
  67. #
  68. html_theme = 'sphinx_rtd_theme'
  69. # Theme options are theme-specific and customize the look and feel of a theme
  70. # further. For a list of options available for each theme, see the
  71. # documentation.
  72. #
  73. # html_theme_options = {}
  74. html_theme_options = {
  75. 'canonical_url': '',
  76. #'analytics_id': 'UA-XXXXXXX-1',
  77. 'logo_only': False,
  78. 'display_version': True,
  79. 'prev_next_buttons_location': 'bottom',
  80. 'style_external_links': False,
  81. #'vcs_pageview_mode': '',
  82. # Toc options
  83. 'collapse_navigation': True,
  84. 'sticky_navigation': True,
  85. 'navigation_depth': 4,
  86. 'includehidden': True,
  87. 'titles_only': False
  88. }
  89. html_context = {
  90. 'display_github': True,
  91. 'github_user': 'jbuisine',
  92. 'github_repo': 'IPFML',
  93. 'github_version': 'master/docs/source/'
  94. }
  95. # Add any paths that contain custom static files (such as style sheets) here,
  96. # relative to this directory. They are copied after the builtin static files,
  97. # so a file named "default.css" will overwrite the builtin "default.css".
  98. html_static_path = ['_static']
  99. # Custom sidebar templates, must be a dictionary that maps document names
  100. # to template names.
  101. #
  102. # The default sidebars (for documents that don't match any pattern) are
  103. # defined by theme itself. Builtin themes are using these templates by
  104. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  105. # 'searchbox.html']``.
  106. #
  107. # html_sidebars = {}
  108. # -- Options for HTMLHelp output ---------------------------------------------
  109. # Output file base name for HTML help builder.
  110. htmlhelp_basename = 'IPFMLdoc'
  111. # -- Options for LaTeX output ------------------------------------------------
  112. latex_elements = {
  113. # The paper size ('letterpaper' or 'a4paper').
  114. #
  115. # 'papersize': 'letterpaper',
  116. # The font size ('10pt', '11pt' or '12pt').
  117. #
  118. # 'pointsize': '10pt',
  119. # Additional stuff for the LaTeX preamble.
  120. #
  121. # 'preamble': '',
  122. # Latex figure (float) alignment
  123. #
  124. # 'figure_align': 'htbp',
  125. }
  126. # Grouping the document tree into LaTeX files. List of tuples
  127. # (source start file, target name, title,
  128. # author, documentclass [howto, manual, or own class]).
  129. latex_documents = [
  130. (master_doc, 'IPFML.tex', 'IPFML Documentation',
  131. 'Jérôme BUISINE', 'manual'),
  132. ]
  133. # -- Options for manual page output ------------------------------------------
  134. # One entry per manual page. List of tuples
  135. # (source start file, name, description, authors, manual section).
  136. man_pages = [
  137. (master_doc, 'ipfml', 'IPFML Documentation',
  138. [author], 1)
  139. ]
  140. # -- Options for Texinfo output ----------------------------------------------
  141. # Grouping the document tree into Texinfo files. List of tuples
  142. # (source start file, target name, title, author,
  143. # dir menu entry, description, category)
  144. texinfo_documents = [
  145. (master_doc, 'IPFML', 'IPFML Documentation',
  146. author, 'IPFML', 'One line description of project.',
  147. 'Miscellaneous'),
  148. ]
  149. # -- Options for Epub output -------------------------------------------------
  150. # Bibliographic Dublin Core info.
  151. epub_title = project
  152. # The unique identifier of the text. This can be a ISBN number
  153. # or the project homepage.
  154. #
  155. # epub_identifier = ''
  156. # A unique identification for the text.
  157. #
  158. # epub_uid = ''
  159. # A list of files that should not be packed into the epub file.
  160. epub_exclude_files = ['search.html']
  161. # -- Extension configuration -------------------------------------------------