A Python parser for MediaWiki wikicode https://mwparserfromhell.readthedocs.io/
25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.

conf.py 8.1 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. # -*- coding: utf-8 -*-
  2. #
  3. # mwparserfromhell documentation build configuration file, created by
  4. # sphinx-quickstart on Tue Aug 21 20:47:26 2012.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # Note that not all possible configuration values are present in this
  9. # autogenerated file.
  10. #
  11. # All configuration values have a default; values that are commented out
  12. # serve to show the default.
  13. import sys, os
  14. # If extensions (or modules to document with autodoc) are in another directory,
  15. # add these directories to sys.path here. If the directory is relative to the
  16. # documentation root, use os.path.abspath to make it absolute, like shown here.
  17. sys.path.insert(0, os.path.abspath(".."))
  18. import mwparserfromhell
  19. # -- General configuration -----------------------------------------------------
  20. # If your documentation needs a minimal Sphinx version, state it here.
  21. # needs_sphinx = '1.0'
  22. # Add any Sphinx extension module names here, as strings. They can be extensions
  23. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  24. extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode"]
  25. # Add any paths that contain templates here, relative to this directory.
  26. templates_path = ["_templates"]
  27. # The suffix of source filenames.
  28. source_suffix = ".rst"
  29. # The encoding of source files.
  30. # source_encoding = 'utf-8-sig'
  31. # The master toctree document.
  32. master_doc = "index"
  33. # General information about the project.
  34. project = "mwparserfromhell"
  35. copyright = "2012–2021 Ben Kurtovic"
  36. # The version info for the project you're documenting, acts as replacement for
  37. # |version| and |release|, also used in various other places throughout the
  38. # built documents.
  39. #
  40. # The short X.Y version.
  41. version = ".".join(mwparserfromhell.__version__.split(".", 2)[:2])
  42. # The full version, including alpha/beta/rc tags.
  43. release = mwparserfromhell.__version__
  44. # The language for content autogenerated by Sphinx. Refer to documentation
  45. # for a list of supported languages.
  46. # language = None
  47. # There are two options for replacing |today|: either, you set today to some
  48. # non-false value, then it is used:
  49. # today = ''
  50. # Else, today_fmt is used as the format for a strftime call.
  51. # today_fmt = '%B %d, %Y'
  52. # List of patterns, relative to source directory, that match files and
  53. # directories to ignore when looking for source files.
  54. exclude_patterns = ["_build"]
  55. # The reST default role (used for this markup: `text`) to use for all documents.
  56. # default_role = None
  57. # If true, '()' will be appended to :func: etc. cross-reference text.
  58. # add_function_parentheses = True
  59. # If true, the current module name will be prepended to all description
  60. # unit titles (such as .. function::).
  61. # add_module_names = True
  62. # If true, sectionauthor and moduleauthor directives will be shown in the
  63. # output. They are ignored by default.
  64. # show_authors = False
  65. # The name of the Pygments (syntax highlighting) style to use.
  66. pygments_style = "sphinx"
  67. # A list of ignored prefixes for module index sorting.
  68. # modindex_common_prefix = []
  69. # -- Options for HTML output ---------------------------------------------------
  70. # The theme to use for HTML and HTML Help pages. See the documentation for
  71. # a list of builtin themes.
  72. html_theme = "nature"
  73. # Theme options are theme-specific and customize the look and feel of a theme
  74. # further. For a list of options available for each theme, see the
  75. # documentation.
  76. # html_theme_options = {}
  77. # Add any paths that contain custom themes here, relative to this directory.
  78. # html_theme_path = []
  79. # The name for this set of Sphinx documents. If None, it defaults to
  80. # "<project> v<release> documentation".
  81. # html_title = None
  82. # A shorter title for the navigation bar. Default is the same as html_title.
  83. # html_short_title = None
  84. # The name of an image file (relative to this directory) to place at the top
  85. # of the sidebar.
  86. # html_logo = None
  87. # The name of an image file (within the static path) to use as favicon of the
  88. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  89. # pixels large.
  90. # html_favicon = None
  91. # Add any paths that contain custom static files (such as style sheets) here,
  92. # relative to this directory. They are copied after the builtin static files,
  93. # so a file named "default.css" will overwrite the builtin "default.css".
  94. html_static_path = ["_static"]
  95. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  96. # using the given strftime format.
  97. # html_last_updated_fmt = '%b %d, %Y'
  98. # If true, SmartyPants will be used to convert quotes and dashes to
  99. # typographically correct entities.
  100. # html_use_smartypants = True
  101. # Custom sidebar templates, maps document names to template names.
  102. # html_sidebars = {}
  103. # Additional templates that should be rendered to pages, maps page names to
  104. # template names.
  105. # html_additional_pages = {}
  106. # If false, no module index is generated.
  107. # html_domain_indices = True
  108. # If false, no index is generated.
  109. # html_use_index = True
  110. # If true, the index is split into individual pages for each letter.
  111. # html_split_index = False
  112. # If true, links to the reST sources are added to the pages.
  113. # html_show_sourcelink = True
  114. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  115. # html_show_sphinx = True
  116. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  117. # html_show_copyright = True
  118. # If true, an OpenSearch description file will be output, and all pages will
  119. # contain a <link> tag referring to it. The value of this option must be the
  120. # base URL from which the finished HTML is served.
  121. # html_use_opensearch = ''
  122. # This is the file name suffix for HTML files (e.g. ".xhtml").
  123. # html_file_suffix = None
  124. # Output file base name for HTML help builder.
  125. htmlhelp_basename = "mwparserfromhelldoc"
  126. # -- Options for LaTeX output --------------------------------------------------
  127. latex_elements = {
  128. # The paper size ('letterpaper' or 'a4paper').
  129. #'papersize': 'letterpaper',
  130. # The font size ('10pt', '11pt' or '12pt').
  131. #'pointsize': '10pt',
  132. # Additional stuff for the LaTeX preamble.
  133. #'preamble': '',
  134. }
  135. # Grouping the document tree into LaTeX files. List of tuples
  136. # (source start file, target name, title, author, documentclass [howto/manual]).
  137. latex_documents = [
  138. (
  139. "index",
  140. "mwparserfromhell.tex",
  141. "mwparserfromhell Documentation",
  142. "Ben Kurtovic",
  143. "manual",
  144. )
  145. ]
  146. # The name of an image file (relative to this directory) to place at the top of
  147. # the title page.
  148. # latex_logo = None
  149. # For "manual" documents, if this is true, then toplevel headings are parts,
  150. # not chapters.
  151. # latex_use_parts = False
  152. # If true, show page references after internal links.
  153. # latex_show_pagerefs = False
  154. # If true, show URL addresses after external links.
  155. # latex_show_urls = False
  156. # Documents to append as an appendix to all manuals.
  157. # latex_appendices = []
  158. # If false, no module index is generated.
  159. # latex_domain_indices = True
  160. # -- Options for manual page output --------------------------------------------
  161. # One entry per manual page. List of tuples
  162. # (source start file, name, description, authors, manual section).
  163. man_pages = [
  164. (
  165. "index",
  166. "mwparserfromhell",
  167. "mwparserfromhell Documentation",
  168. ["Ben Kurtovic"],
  169. 1,
  170. )
  171. ]
  172. # If true, show URL addresses after external links.
  173. # man_show_urls = False
  174. # -- Options for Texinfo output ------------------------------------------------
  175. # Grouping the document tree into Texinfo files. List of tuples
  176. # (source start file, target name, title, author,
  177. # dir menu entry, description, category)
  178. texinfo_documents = [
  179. (
  180. "index",
  181. "mwparserfromhell",
  182. "mwparserfromhell Documentation",
  183. "Ben Kurtovic",
  184. "mwparserfromhell",
  185. "One line description of project.",
  186. "Miscellaneous",
  187. )
  188. ]
  189. # Documents to append as an appendix to all manuals.
  190. # texinfo_appendices = []
  191. # If false, no module index is generated.
  192. # texinfo_domain_indices = True
  193. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  194. # texinfo_show_urls = 'footnote'
  195. # Example configuration for intersphinx: refer to the Python standard library.
  196. intersphinx_mapping = {"http://docs.python.org/": None}