/conf.py

https://github.com/ZoomQuiet/sphinx-doc-zh · Python · 100 lines · 75 code · 19 blank · 6 comment · 2 complexity · 203363398743225468a86a728d1a4238 MD5 · raw file 

    

  1. # -*- coding: utf-8 -*-
    2. 

  2. #
    3. 

  3. # Sphinx documentation build configuration file
    4. 

  4. 

  5. import re
    6. 

  6. import sphinx
    7. 

  7. 

  8. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
    9. 

  9.               'sphinx.ext.autosummary', 'sphinx.ext.extlinks']
    10. 

  10. 

  11. master_doc = 'contents'
    12. 

  12. templates_path = ['_templates']
    13. 

  13. exclude_patterns = ['_build']
    14. 

  14. 

  15. project = 'Sphinx'
    16. 

  16. copyright = '2007-2010, Georg Brandl'
    17. 

  17. version = sphinx.__released__
    18. 

  18. release = version
    19. 

  19. show_authors = True
    20. 

  20. 

  21. html_theme = 'sphinxdoc'
    22. 

  22. modindex_common_prefix = ['sphinx.']
    23. 

  23. html_static_path = ['_static']
    24. 

  24. html_index = 'index.html'
    25. 

  25. html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
    26. 

  26. html_additional_pages = {'index': 'index.html'}
    27. 

  27. html_use_opensearch = 'http://sphinx.pocoo.org'
    28. 

  28. 

  29. htmlhelp_basename = 'Sphinxdoc'
    30. 

  30. 

  31. epub_theme = 'epub'
    32. 

  32. epub_basename = 'sphinx'
    33. 

  33. epub_author = 'Georg Brandl'
    34. 

  34. epub_publisher = 'http://sphinx.pocoo.org/'
    35. 

  35. epub_scheme = 'url'
    36. 

  36. epub_identifier = epub_publisher
    37. 

  37. epub_pre_files = [('index.html', 'Welcome')]
    38. 

  38. epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
    39. 

  39.     '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js',
    40. 

  40.     '_static/basic.css', 'search.html']
    41. 

  41. 

  42. latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation',
    43. 

  43.                     'Georg Brandl', 'manual', 1)]
    44. 

  44. latex_logo = '_static/sphinx.png'
    45. 

  45. latex_elements = {
    46. 

  46.     'fontpkg': '\\usepackage{palatino}',
    47. 

  47. }
    48. 

  48. 

  49. autodoc_member_order = 'groupwise'
    50. 

  50. todo_include_todos = True
    51. 

  51. extlinks = {'duref': ('http://docutils.sourceforge.net/docs/ref/rst/'
    52. 

  52.                       'restructuredtext.html#%s', ''),
    53. 

  53.             'durole': ('http://docutils.sourceforge.net/docs/ref/rst/'
    54. 

  54.                        'roles.html#%s', ''),
    55. 

  55.             'dudir': ('http://docutils.sourceforge.net/docs/ref/rst/'
    56. 

  56.                       'directives.html#%s', '')}
    57. 

  57. 

  58. man_pages = [
    59. 

  59.     ('contents', 'sphinx-all', 'Sphinx documentation generator system manual',
    60. 

  60.      'Georg Brandl', 1),
    61. 

  61.     ('man/sphinx-build', 'sphinx-build', 'Sphinx documentation generator tool',
    62. 

  62.      '', 1),
    63. 

  63.     ('man/sphinx-quickstart', 'sphinx-quickstart', 'Sphinx documentation '
    64. 

  64.      'template generator', '', 1),
    65. 

  65. ]
    66. 

  66. 

  67. # We're not using intersphinx right now, but if we did, this would be part of
    68. 

  68. # the mapping:
    69. 

  69. intersphinx_mapping = {'python': ('http://docs.python.org/dev', None)}
    70. 

  70. 

  71. 

  72. # -- Extension interface -------------------------------------------------------
    73. 

  73. 

  74. from sphinx import addnodes
    75. 

  75. 

  76. 

  77. event_sig_re = re.compile(r'([a-zA-Z-]+)\s*\((.*)\)')
    78. 

  78. 

  79. def parse_event(env, sig, signode):
    80. 

  80.     m = event_sig_re.match(sig)
    81. 

  81.     if not m:
    82. 

  82.         signode += addnodes.desc_name(sig, sig)
    83. 

  83.         return sig
    84. 

  84.     name, args = m.groups()
    85. 

  85.     signode += addnodes.desc_name(name, name)
    86. 

  86.     plist = addnodes.desc_parameterlist()
    87. 

  87.     for arg in args.split(','):
    88. 

  88.         arg = arg.strip()
    89. 

  89.         plist += addnodes.desc_parameter(arg, arg)
    90. 

  90.     signode += plist
    91. 

  91.     return name
    92. 

  92. 

  93. 

  94. def setup(app):
    95. 

  95.     from sphinx.ext.autodoc import cut_lines
    96. 

  96.     app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
    97. 

  97.     app.add_description_unit('confval', 'confval',
    98. 

  98.                              objname='configuration value',
    99. 

  99.                              indextemplate='pair: %s; configuration value')
    100. 

  100.     app.add_description_unit('event', 'event', 'pair: %s; event', parse_event)
    101.