/docs/conf.py

https://bitbucket.org/jmoiron/johnny-cache/ · Python · 202 lines · 29 code · 52 blank · 121 comment · 3 complexity · 9430f8fbc46011fe60f8cc60d58a3d79 MD5 · raw file

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Johnny Cache documentation build configuration file, created by
  4. # sphinx-quickstart on Thu Feb 18 22:05:30 2010.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # Note that not all possible configuration values are present in this
  9. # autogenerated file.
  10. #
  11. # All configuration values have a default; values that are commented out
  12. # serve to show the default.
  13. import sys, os
  14. # If extensions (or modules to document with autodoc) are in another directory,
  15. # add these directories to sys.path here. If the directory is relative to the
  16. # documentation root, use os.path.abspath to make it absolute, like shown here.
  17. projpath = os.path.abspath('..')
  18. sys.path.append(projpath)
  19. # -- General configuration -----------------------------------------------------
  20. # Add any Sphinx extension module names here, as strings. They can be extensions
  21. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  22. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
  23. # Add any paths that contain templates here, relative to this directory.
  24. templates_path = ['_templates']
  25. # The suffix of source filenames.
  26. source_suffix = '.rst'
  27. # The encoding of source files.
  28. source_encoding = 'utf-8'
  29. # The master toctree document.
  30. master_doc = 'index'
  31. # General information about the project.
  32. project = u'Johnny Cache'
  33. copyright = u'2010, Jason Moiron, Jeremy Self'
  34. # The version info for the project you're documenting, acts as replacement for
  35. # |version| and |release|, also used in various other places throughout the
  36. # built documents.
  37. #
  38. # The short X.Y version.
  39. version = None
  40. for line in open(os.path.join(projpath, 'setup.py'), 'r'):
  41. if line.startswith('version'):
  42. exec line
  43. if version is None:
  44. version = '0.1'
  45. # The full version, including alpha/beta/rc tags.
  46. release = version
  47. print ("Building release: %s, version: %s" % (release, version))
  48. # The language for content autogenerated by Sphinx. Refer to documentation
  49. # for a list of supported languages.
  50. #language = None
  51. # There are two options for replacing |today|: either, you set today to some
  52. # non-false value, then it is used:
  53. #today = ''
  54. # Else, today_fmt is used as the format for a strftime call.
  55. #today_fmt = '%B %d, %Y'
  56. # List of documents that shouldn't be included in the build.
  57. #unused_docs = []
  58. # List of directories, relative to source directory, that shouldn't be searched
  59. # for source files.
  60. exclude_trees = ['_build']
  61. # The reST default role (used for this markup: `text`) to use for all documents.
  62. #default_role = None
  63. # If true, '()' will be appended to :func: etc. cross-reference text.
  64. #add_function_parentheses = True
  65. # If true, the current module name will be prepended to all description
  66. # unit titles (such as .. function::).
  67. #add_module_names = True
  68. # If true, sectionauthor and moduleauthor directives will be shown in the
  69. # output. They are ignored by default.
  70. #show_authors = False
  71. # The name of the Pygments (syntax highlighting) style to use.
  72. pygments_style = 'sphinx'
  73. # A list of ignored prefixes for module index sorting.
  74. #modindex_common_prefix = []
  75. # -- Options for HTML output ---------------------------------------------------
  76. # The theme to use for HTML and HTML Help pages. Major themes that come with
  77. # Sphinx are currently 'default' and 'sphinxdoc'.
  78. html_theme = 'nature'
  79. # Theme options are theme-specific and customize the look and feel of a theme
  80. # further. For a list of options available for each theme, see the
  81. # documentation.
  82. #html_theme_options = {}
  83. # Add any paths that contain custom themes here, relative to this directory.
  84. html_theme_path = ['_theme']
  85. # The name for this set of Sphinx documents. If None, it defaults to
  86. # "<project> v<release> documentation".
  87. #html_title = None
  88. # A shorter title for the navigation bar. Default is the same as html_title.
  89. #html_short_title = None
  90. # The name of an image file (relative to this directory) to place at the top
  91. # of the sidebar.
  92. #html_logo = None
  93. # The name of an image file (within the static path) to use as favicon of the
  94. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  95. # pixels large.
  96. #html_favicon = None
  97. # Add any paths that contain custom static files (such as style sheets) here,
  98. # relative to this directory. They are copied after the builtin static files,
  99. # so a file named "default.css" will overwrite the builtin "default.css".
  100. html_static_path = ['_static']
  101. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  102. # using the given strftime format.
  103. #html_last_updated_fmt = '%b %d, %Y'
  104. # If true, SmartyPants will be used to convert quotes and dashes to
  105. # typographically correct entities.
  106. #html_use_smartypants = True
  107. # Custom sidebar templates, maps document names to template names.
  108. #html_sidebars = {}
  109. # Additional templates that should be rendered to pages, maps page names to
  110. # template names.
  111. #html_additional_pages = {}
  112. # If false, no module index is generated.
  113. #html_use_modindex = True
  114. # If false, no index is generated.
  115. #html_use_index = True
  116. # If true, the index is split into individual pages for each letter.
  117. #html_split_index = False
  118. # If true, links to the reST sources are added to the pages.
  119. html_show_sourcelink = False
  120. # If true, an OpenSearch description file will be output, and all pages will
  121. # contain a <link> tag referring to it. The value of this option must be the
  122. # base URL from which the finished HTML is served.
  123. #html_use_opensearch = ''
  124. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  125. #html_file_suffix = ''
  126. # Output file base name for HTML help builder.
  127. htmlhelp_basename = 'JohnnyCachedoc'
  128. # -- Options for LaTeX output --------------------------------------------------
  129. # The paper size ('letter' or 'a4').
  130. #latex_paper_size = 'letter'
  131. # The font size ('10pt', '11pt' or '12pt').
  132. #latex_font_size = '10pt'
  133. # Grouping the document tree into LaTeX files. List of tuples
  134. # (source start file, target name, title, author, documentclass [howto/manual]).
  135. latex_documents = [
  136. ('index', 'JohnnyCache.tex', u'Johnny Cache Documentation',
  137. u'Jason Moiron, Jeremy Self', 'manual'),
  138. ]
  139. # The name of an image file (relative to this directory) to place at the top of
  140. # the title page.
  141. #latex_logo = None
  142. # For "manual" documents, if this is true, then toplevel headings are parts,
  143. # not chapters.
  144. #latex_use_parts = False
  145. # Additional stuff for the LaTeX preamble.
  146. #latex_preamble = ''
  147. # Documents to append as an appendix to all manuals.
  148. #latex_appendices = []
  149. # If false, no module index is generated.
  150. #latex_use_modindex = True