An ebook/comic library service and web client

155 lines
4.6 KiB

  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('.'))
  16. # -- Project information -----------------------------------------------------
  17. project = 'Atheneum'
  18. copyright = '2018, Drew Short'
  19. author = 'Drew Short'
  20. # The short X.Y version
  21. version = '2018.8'
  22. # The full version, including alpha/beta/rc tags
  23. release = '2018.8.1'
  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. ]
  33. # Add any paths that contain templates here, relative to this directory.
  34. templates_path = ['_templates']
  35. # The suffix(es) of source filenames.
  36. # You can specify multiple suffix as a list of string:
  37. #
  38. # source_suffix = ['.rst', '.md']
  39. source_suffix = '.rst'
  40. # The master toctree document.
  41. master_doc = 'index'
  42. # The language for content autogenerated by Sphinx. Refer to documentation
  43. # for a list of supported languages.
  44. #
  45. # This is also used if you do content translation via gettext catalogs.
  46. # Usually you set "language" from the command line for these cases.
  47. language = None
  48. # List of patterns, relative to source directory, that match files and
  49. # directories to ignore when looking for source files.
  50. # This pattern also affects html_static_path and html_extra_path .
  51. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  52. # The name of the Pygments (syntax highlighting) style to use.
  53. pygments_style = 'sphinx'
  54. # -- Options for HTML output -------------------------------------------------
  55. # The theme to use for HTML and HTML Help pages. See the documentation for
  56. # a list of builtin themes.
  57. #
  58. html_theme = 'sphinx_rtd_theme'
  59. # Theme options are theme-specific and customize the look and feel of a theme
  60. # further. For a list of options available for each theme, see the
  61. # documentation.
  62. #
  63. # html_theme_options = {}
  64. # Add any paths that contain custom static files (such as style sheets) here,
  65. # relative to this directory. They are copied after the builtin static files,
  66. # so a file named "default.css" will overwrite the builtin "default.css".
  67. html_static_path = ['_static']
  68. # Custom sidebar templates, must be a dictionary that maps document names
  69. # to template names.
  70. #
  71. # The default sidebars (for documents that don't match any pattern) are
  72. # defined by theme itself. Builtin themes are using these templates by
  73. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  74. # 'searchbox.html']``.
  75. #
  76. # html_sidebars = {}
  77. # -- Options for HTMLHelp output ---------------------------------------------
  78. # Output file base name for HTML help builder.
  79. htmlhelp_basename = 'Atheneumdoc'
  80. # -- Options for LaTeX output ------------------------------------------------
  81. latex_elements = {
  82. # The paper size ('letterpaper' or 'a4paper').
  83. #
  84. # 'papersize': 'letterpaper',
  85. # The font size ('10pt', '11pt' or '12pt').
  86. #
  87. # 'pointsize': '10pt',
  88. # Additional stuff for the LaTeX preamble.
  89. #
  90. # 'preamble': '',
  91. # Latex figure (float) alignment
  92. #
  93. # 'figure_align': 'htbp',
  94. }
  95. # Grouping the document tree into LaTeX files. List of tuples
  96. # (source start file, target name, title,
  97. # author, documentclass [howto, manual, or own class]).
  98. latex_documents = [
  99. (master_doc, 'Atheneum.tex', 'Atheneum Documentation',
  100. 'Drew Short', 'manual'),
  101. ]
  102. # -- Options for manual page output ------------------------------------------
  103. # One entry per manual page. List of tuples
  104. # (source start file, name, description, authors, manual section).
  105. man_pages = [
  106. (master_doc, 'atheneum', 'Atheneum Documentation',
  107. [author], 1)
  108. ]
  109. # -- Options for Texinfo output ----------------------------------------------
  110. # Grouping the document tree into Texinfo files. List of tuples
  111. # (source start file, target name, title, author,
  112. # dir menu entry, description, category)
  113. texinfo_documents = [
  114. (master_doc, 'Atheneum', 'Atheneum Documentation',
  115. author, 'Atheneum', 'One line description of project.',
  116. 'Miscellaneous'),
  117. ]