PageRenderTime 43ms CodeModel.GetById 8ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/conf.py

https://bitbucket.org/ianb/silverlining/
Python | 136 lines | 17 code | 36 blank | 83 comment | 0 complexity | f2e577fc97e20c1a81752e2cb9ebc107 MD5 | raw file
Possible License(s): GPL-2.0
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Paste documentation build configuration file, created by
  4. # sphinx-quickstart on Tue Apr 22 22:08:49 2008.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # The contents of this file are pickled, so don't put values in the namespace
  9. # that aren't pickleable (module imports are okay, they're removed automatically).
  10. #
  11. # All configuration values have a default value; values that are commented out
  12. # serve to show the default value.
  13. import sys
  14. # If your extensions are in another directory, add it here.
  15. #sys.path.append('some/directory')
  16. # General configuration
  17. # ---------------------
  18. # Add any Sphinx extension module names here, as strings. They can be extensions
  19. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  20. extensions = ['sphinx.ext.autodoc']
  21. # Add any paths that contain templates here, relative to this directory.
  22. templates_path = ['_templates']
  23. # The suffix of source filenames.
  24. source_suffix = '.txt'
  25. # The master toctree document.
  26. master_doc = 'index'
  27. # General substitutions.
  28. project = 'Silver Lining'
  29. copyright = '2010, Ian Bicking'
  30. # The default replacements for |version| and |release|, also used in various
  31. # other places throughout the built documents.
  32. #
  33. # The short X.Y version.
  34. version = '0.0'
  35. # The full version, including alpha/beta/rc tags.
  36. release = '0.0'
  37. # There are two options for replacing |today|: either, you set today to some
  38. # non-false value, then it is used:
  39. #today = ''
  40. # Else, today_fmt is used as the format for a strftime call.
  41. today_fmt = '%B %d, %Y'
  42. # List of documents that shouldn't be included in the build.
  43. unused_docs = []
  44. # If true, '()' will be appended to :func: etc. cross-reference text.
  45. #add_function_parentheses = True
  46. # If true, the current module name will be prepended to all description
  47. # unit titles (such as .. function::).
  48. #add_module_names = True
  49. # If true, sectionauthor and moduleauthor directives will be shown in the
  50. # output. They are ignored by default.
  51. #show_authors = False
  52. # The name of the Pygments (syntax highlighting) style to use.
  53. pygments_style = 'sphinx'
  54. # Options for HTML output
  55. # -----------------------
  56. html_theme = 'nature'
  57. html_theme_path = ['_theme']
  58. #html_favicon = 'favicon.ico'
  59. # The style sheet to use for HTML and HTML Help pages. A file of that name
  60. # must exist either in Sphinx' static/ path, or in one of the custom paths
  61. # given in html_static_path.
  62. #html_style = 'default.css'
  63. # Add any paths that contain custom static files (such as style sheets) here,
  64. # relative to this directory. They are copied after the builtin static files,
  65. # so a file named "default.css" will overwrite the builtin "default.css".
  66. html_static_path = ['_static']
  67. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  68. # using the given strftime format.
  69. html_last_updated_fmt = '%b %d, %Y'
  70. # If true, SmartyPants will be used to convert quotes and dashes to
  71. # typographically correct entities.
  72. #html_use_smartypants = True
  73. # Content template for the index page.
  74. #html_index = ''
  75. # Custom sidebar templates, maps document names to template names.
  76. #html_sidebars = {}
  77. # Additional templates that should be rendered to pages, maps page names to
  78. # template names.
  79. #html_additional_pages = {}
  80. # If false, no module index is generated.
  81. #html_use_modindex = True
  82. # If true, the reST sources are included in the HTML build as _sources/<name>.
  83. #html_copy_source = True
  84. # Output file base name for HTML help builder.
  85. htmlhelp_basename = 'silverliningdoc'
  86. # Options for LaTeX output
  87. # ------------------------
  88. # The paper size ('letter' or 'a4').
  89. #latex_paper_size = 'letter'
  90. # The font size ('10pt', '11pt' or '12pt').
  91. #latex_font_size = '10pt'
  92. # Grouping the document tree into LaTeX files. List of tuples
  93. # (source start file, target name, title, author, document class [howto/manual]).
  94. #latex_documents = []
  95. # Additional stuff for the LaTeX preamble.
  96. #latex_preamble = ''
  97. # Documents to append as an appendix to all manuals.
  98. #latex_appendices = []
  99. # If false, no module index is generated.
  100. #latex_use_modindex = True