conf.py 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Configuration file for the Sphinx documentation builder.
  4. #
  5. # This file does only contain a selection of the most common options. For a
  6. # full list see the documentation:
  7. # https://www.sphinx-doc.org/en/master/usage/configuration.html
  8. # -- Path setup --------------------------------------------------------------
  9. # If extensions (or modules to document with autodoc) are in another directory,
  10. # add these directories to sys.path here. If the directory is relative to the
  11. # documentation root, use os.path.abspath to make it absolute, like shown here.
  12. #
  13. import os
  14. import sys
  15. sys.path.insert(0, os.path.abspath('..'))
  16. from pyparsing import __version__ as pyparsing_version
  17. # -- Project information -----------------------------------------------------
  18. project = 'PyParsing'
  19. copyright = '2018, Paul T. McGuire'
  20. author = 'Paul T. McGuire'
  21. # The short X.Y version
  22. version = pyparsing_version
  23. # The full version, including alpha/beta/rc tags
  24. release = pyparsing_version
  25. # -- General configuration ---------------------------------------------------
  26. # If your documentation needs a minimal Sphinx version, state it here.
  27. #
  28. # needs_sphinx = '1.0'
  29. # Add any Sphinx extension module names here, as strings. They can be
  30. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  31. # ones.
  32. extensions = [
  33. 'sphinx.ext.autodoc',
  34. ]
  35. # Add any paths that contain templates here, relative to this directory.
  36. templates_path = ['_templates']
  37. # The suffix(es) of source filenames.
  38. # You can specify multiple suffix as a list of string:
  39. #
  40. # source_suffix = ['.rst', '.md']
  41. source_suffix = '.rst'
  42. # The master toctree document.
  43. master_doc = 'index'
  44. # The language for content autogenerated by Sphinx. Refer to documentation
  45. # for a list of supported languages.
  46. #
  47. # This is also used if you do content translation via gettext catalogs.
  48. # Usually you set "language" from the command line for these cases.
  49. language = None
  50. # List of patterns, relative to source directory, that match files and
  51. # directories to ignore when looking for source files.
  52. # This pattern also affects html_static_path and html_extra_path .
  53. exclude_patterns = []
  54. # The name of the Pygments (syntax highlighting) style to use.
  55. pygments_style = 'sphinx'
  56. # -- Options for HTML output -------------------------------------------------
  57. # The theme to use for HTML and HTML Help pages. See the documentation for
  58. # a list of builtin themes.
  59. #
  60. html_theme = 'alabaster'
  61. # Theme options are theme-specific and customize the look and feel of a theme
  62. # further. For a list of options available for each theme, see the
  63. # documentation.
  64. #
  65. # html_theme_options = {}
  66. # Add any paths that contain custom static files (such as style sheets) here,
  67. # relative to this directory. They are copied after the builtin static files,
  68. # so a file named "default.css" will overwrite the builtin "default.css".
  69. html_static_path = ['_static']
  70. # Custom sidebar templates, must be a dictionary that maps document names
  71. # to template names.
  72. #
  73. # The default sidebars (for documents that don't match any pattern) are
  74. # defined by theme itself. Builtin themes are using these templates by
  75. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  76. # 'searchbox.html']``.
  77. #
  78. # html_sidebars = {}
  79. # -- Options for HTMLHelp output ---------------------------------------------
  80. # Output file base name for HTML help builder.
  81. htmlhelp_basename = 'PyParsingdoc'
  82. # -- Options for LaTeX output ------------------------------------------------
  83. latex_elements = {
  84. # The paper size ('letterpaper' or 'a4paper').
  85. #
  86. # 'papersize': 'letterpaper',
  87. # The font size ('10pt', '11pt' or '12pt').
  88. #
  89. # 'pointsize': '10pt',
  90. # Additional stuff for the LaTeX preamble.
  91. #
  92. # 'preamble': '',
  93. # Latex figure (float) alignment
  94. #
  95. # 'figure_align': 'htbp',
  96. }
  97. # Grouping the document tree into LaTeX files. List of tuples
  98. # (source start file, target name, title,
  99. # author, documentclass [howto, manual, or own class]).
  100. latex_documents = [
  101. (master_doc, 'PyParsing.tex', 'PyParsing Documentation',
  102. 'Paul T. McGuire', 'manual'),
  103. ]
  104. # -- Options for manual page output ------------------------------------------
  105. # One entry per manual page. List of tuples
  106. # (source start file, name, description, authors, manual section).
  107. man_pages = [
  108. (master_doc, 'pyparsing', 'PyParsing Documentation',
  109. [author], 1)
  110. ]
  111. # -- Options for Texinfo output ----------------------------------------------
  112. # Grouping the document tree into Texinfo files. List of tuples
  113. # (source start file, target name, title, author,
  114. # dir menu entry, description, category)
  115. texinfo_documents = [
  116. (master_doc, 'PyParsing', 'PyParsing Documentation',
  117. author, 'PyParsing', 'One line description of project.',
  118. 'Miscellaneous'),
  119. ]
  120. # -- Options for Epub output -------------------------------------------------
  121. # Bibliographic Dublin Core info.
  122. epub_title = project
  123. epub_author = author
  124. epub_publisher = author
  125. epub_copyright = copyright
  126. # The unique identifier of the text. This can be a ISBN number
  127. # or the project homepage.
  128. #
  129. # epub_identifier = ''
  130. # A unique identification for the text.
  131. #
  132. # epub_uid = ''
  133. # A list of files that should not be packed into the epub file.
  134. epub_exclude_files = ['search.html']
  135. # -- Extension configuration -------------------------------------------------