conf.py 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. extensions = []
  8. templates_path = ['_templates']
  9. source_suffix = '.rst'
  10. master_doc = 'index'
  11. project = u'Guzzle'
  12. copyright = u'2015, Michael Dowling'
  13. version = '6'
  14. html_title = "Guzzle Documentation"
  15. html_short_title = "Guzzle 6"
  16. exclude_patterns = ['_build']
  17. html_static_path = ['_static']
  18. ##### Guzzle sphinx theme
  19. import guzzle_sphinx_theme
  20. html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
  21. html_theme_path = guzzle_sphinx_theme.html_theme_path()
  22. html_theme = 'guzzle_sphinx_theme'
  23. # Custom sidebar templates, maps document names to template names.
  24. html_sidebars = {
  25. '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
  26. }
  27. # Register the theme as an extension to generate a sitemap.xml
  28. extensions.append("guzzle_sphinx_theme")
  29. # Guzzle theme options (see theme.conf for more information)
  30. html_theme_options = {
  31. # Set the path to a special layout to include for the homepage
  32. # "index_template": "homepage.html",
  33. # Allow a separate homepage from the master_doc
  34. # homepage = index
  35. # Set the name of the project to appear in the nav menu
  36. # "project_nav_name": "Guzzle",
  37. # Set your Disqus short name to enable comments
  38. # "disqus_comments_shortname": "my_disqus_comments_short_name",
  39. # Set you GA account ID to enable tracking
  40. # "google_analytics_account": "my_ga_account",
  41. # Path to a touch icon
  42. # "touch_icon": "",
  43. # Specify a base_url used to generate sitemap.xml links. If not
  44. # specified, then no sitemap will be built.
  45. "base_url": "http://guzzlephp.org"
  46. # Allow the "Table of Contents" page to be defined separately from "master_doc"
  47. # tocpage = Contents
  48. # Allow the project link to be overriden to a custom URL.
  49. # projectlink = http://myproject.url
  50. }