conf.py 5.6 KB

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