conf.py 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. import sys, os
  2. from sphinx.highlighting import lexers
  3. from pygments.lexers.web import PhpLexer
  4. lexers['php'] = PhpLexer(startinline=True, linenos=1)
  5. lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
  6. primary_domain = 'php'
  7. # -- General configuration -----------------------------------------------------
  8. extensions = []
  9. templates_path = ['_templates']
  10. source_suffix = '.rst'
  11. master_doc = 'index'
  12. project = u'Guzzle'
  13. copyright = u'2012, Michael Dowling'
  14. version = '3.0.0'
  15. release = '3.0.0'
  16. exclude_patterns = ['_build']
  17. # -- Options for HTML output ---------------------------------------------------
  18. # The name for this set of Sphinx documents. If None, it defaults to
  19. # "<project> v<release> documentation".
  20. html_title = "Guzzle documentation"
  21. html_short_title = "Guzzle"
  22. # Add any paths that contain custom static files (such as style sheets) here,
  23. # relative to this directory. They are copied after the builtin static files,
  24. # so a file named "default.css" will overwrite the builtin "default.css".
  25. html_static_path = ['_static']
  26. # Custom sidebar templates, maps document names to template names.
  27. html_sidebars = {
  28. '**': ['localtoc.html', 'leftbar.html', 'searchbox.html']
  29. }
  30. # Output file base name for HTML help builder.
  31. htmlhelp_basename = 'Guzzledoc'
  32. # -- Guzzle Sphinx theme setup ------------------------------------------------
  33. sys.path.insert(0, '/Users/dowling/projects/guzzle_sphinx_theme')
  34. import guzzle_sphinx_theme
  35. html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
  36. html_theme_path = guzzle_sphinx_theme.html_theme_path()
  37. html_theme = 'guzzle_sphinx_theme'
  38. # Guzzle theme options (see theme.conf for more information)
  39. html_theme_options = {
  40. "index_template": "index.html",
  41. "project_nav_name": "Guzzle",
  42. "github_user": "guzzle",
  43. "github_repo": "guzzle",
  44. "disqus_comments_shortname": "guzzle",
  45. "google_analytics_account": "UA-22752917-1"
  46. }
  47. # -- Options for LaTeX output --------------------------------------------------
  48. latex_elements = {}
  49. # Grouping the document tree into LaTeX files. List of tuples
  50. # (source start file, target name, title, author, documentclass [howto/manual]).
  51. latex_documents = [
  52. ('index', 'Guzzle.tex', u'Guzzle Documentation',
  53. u'Michael Dowling', 'manual'),
  54. ]
  55. # -- Options for manual page output --------------------------------------------
  56. # One entry per manual page. List of tuples
  57. # (source start file, name, description, authors, manual section).
  58. man_pages = [
  59. ('index', 'guzzle', u'Guzzle Documentation',
  60. [u'Michael Dowling'], 1)
  61. ]
  62. # If true, show URL addresses after external links.
  63. #man_show_urls = False
  64. # -- Options for Texinfo output ------------------------------------------------
  65. # Grouping the document tree into Texinfo files. List of tuples
  66. # (source start file, target name, title, author,
  67. # dir menu entry, description, category)
  68. texinfo_documents = [
  69. ('index', 'Guzzle', u'Guzzle Documentation',
  70. u'Michael Dowling', 'Guzzle', 'One line description of project.',
  71. 'Miscellaneous'),
  72. ]