conf.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. #!/usr/bin/env python
  2. #
  3. # py_thesis_toolbox documentation build configuration file, created by
  4. # sphinx-quickstart on Fri Jun 9 13:47:02 2017.
  5. #
  6. # This file is execfile()d with the current directory set to its
  7. # containing dir.
  8. #
  9. # Note that not all possible configuration values are present in this
  10. # autogenerated file.
  11. #
  12. # All configuration values have a default; values that are commented out
  13. # serve to show the default.
  14. # If extensions (or modules to document with autodoc) are in another
  15. # directory, add these directories to sys.path here. If the directory is
  16. # relative to the documentation root, use os.path.abspath to make it
  17. # absolute, like shown here.
  18. #
  19. import os
  20. import sys
  21. sys.path.insert(0, os.path.abspath('..'))
  22. import py_thesis_toolbox
  23. # -- General configuration ---------------------------------------------
  24. # If your documentation needs a minimal Sphinx version, state it here.
  25. #
  26. # needs_sphinx = '1.0'
  27. # Add any Sphinx extension module names here, as strings. They can be
  28. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  29. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
  30. # Add any paths that contain templates here, relative to this directory.
  31. templates_path = ['_templates']
  32. # The suffix(es) of source filenames.
  33. # You can specify multiple suffix as a list of string:
  34. #
  35. # source_suffix = ['.rst', '.md']
  36. source_suffix = '.rst'
  37. # The master toctree document.
  38. master_doc = 'index'
  39. # General information about the project.
  40. project = 'py_thesis_toolbox'
  41. copyright = "2021, Ali BELLAMINE"
  42. author = "Ali BELLAMINE"
  43. # The version info for the project you're documenting, acts as replacement
  44. # for |version| and |release|, also used in various other places throughout
  45. # the built documents.
  46. #
  47. # The short X.Y version.
  48. version = py_thesis_toolbox.__version__
  49. # The full version, including alpha/beta/rc tags.
  50. release = py_thesis_toolbox.__version__
  51. # The language for content autogenerated by Sphinx. Refer to documentation
  52. # for a list of supported languages.
  53. #
  54. # This is also used if you do content translation via gettext catalogs.
  55. # Usually you set "language" from the command line for these cases.
  56. language = None
  57. # List of patterns, relative to source directory, that match files and
  58. # directories to ignore when looking for source files.
  59. # This patterns also effect to html_static_path and html_extra_path
  60. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  61. # The name of the Pygments (syntax highlighting) style to use.
  62. pygments_style = 'sphinx'
  63. # If true, `todo` and `todoList` produce output, else they produce nothing.
  64. todo_include_todos = False
  65. # -- Options for HTML output -------------------------------------------
  66. # The theme to use for HTML and HTML Help pages. See the documentation for
  67. # a list of builtin themes.
  68. #
  69. html_theme = 'alabaster'
  70. # Theme options are theme-specific and customize the look and feel of a
  71. # theme further. For a list of options available for each theme, see the
  72. # documentation.
  73. #
  74. # html_theme_options = {}
  75. # Add any paths that contain custom static files (such as style sheets) here,
  76. # relative to this directory. They are copied after the builtin static files,
  77. # so a file named "default.css" will overwrite the builtin "default.css".
  78. html_static_path = ['_static']
  79. # -- Options for HTMLHelp output ---------------------------------------
  80. # Output file base name for HTML help builder.
  81. htmlhelp_basename = 'py_thesis_toolboxdoc'
  82. # -- Options for LaTeX output ------------------------------------------
  83. latex_elements = {
  84. # The paper size ('letterpaper' or 'a4paper').
  85. #
  86. # 'papersize': 'letterpaper',
  87. # The font size ('10pt', '11pt' or '12pt').
  88. #
  89. # 'pointsize': '10pt',
  90. # Additional stuff for the LaTeX preamble.
  91. #
  92. # 'preamble': '',
  93. # Latex figure (float) alignment
  94. #
  95. # 'figure_align': 'htbp',
  96. }
  97. # Grouping the document tree into LaTeX files. List of tuples
  98. # (source start file, target name, title, author, documentclass
  99. # [howto, manual, or own class]).
  100. latex_documents = [
  101. (master_doc, 'py_thesis_toolbox.tex',
  102. 'py_thesis_toolbox Documentation',
  103. 'Ali BELLAMINE', 'manual'),
  104. ]
  105. # -- Options for manual page output ------------------------------------
  106. # One entry per manual page. List of tuples
  107. # (source start file, name, description, authors, manual section).
  108. man_pages = [
  109. (master_doc, 'py_thesis_toolbox',
  110. 'py_thesis_toolbox Documentation',
  111. [author], 1)
  112. ]
  113. # -- Options for Texinfo output ----------------------------------------
  114. # Grouping the document tree into Texinfo files. List of tuples
  115. # (source start file, target name, title, author,
  116. # dir menu entry, description, category)
  117. texinfo_documents = [
  118. (master_doc, 'py_thesis_toolbox',
  119. 'py_thesis_toolbox Documentation',
  120. author,
  121. 'py_thesis_toolbox',
  122. 'One line description of project.',
  123. 'Miscellaneous'),
  124. ]