Shared Memory Dictionary utilizing Posix IPC semaphores and shared memory segments and offering permanent disk storage of data if required.
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. # -*- coding: utf-8 -*-
  2. # pylint: disable=invalid-name
  3. #
  4. # Configuration file for the Sphinx documentation builder.
  5. #
  6. # This file does only contain a selection of the most common options. For a
  7. # full list see the documentation:
  8. # http://www.sphinx-doc.org/en/master/config
  9. # -- Path setup --------------------------------------------------------------
  10. # If extensions (or modules to document with autodoc) are in another directory,
  11. # add these directories to sys.path here. If the directory is relative to the
  12. # documentation root, use os.path.abspath to make it absolute, like shown here.
  13. #
  14. import os
  15. import sys
  16. from shm_dict._version import __version__ # pylint: disable=wrong-import-position
  17. # Add base directory to path
  18. # (shm_dict/docs/source/conf.py -> shm_dict/docs/source -> shm_dict/docs -> shm_dict)
  19. sys.path.insert(
  20. 0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  21. )
  22. # -- Project information -----------------------------------------------------
  23. project = "Shared Memory Dictionary"
  24. copyright = "2019, Nate Bohman" # pylint: disable=redefined-builtin
  25. author = "Nate Bohman"
  26. # The short X.Y version
  27. # version = ''
  28. version = __version__
  29. # The full version, including alpha/beta/rc tags
  30. # release = '2018.10.25.12.00'
  31. release = __version__
  32. # -- General configuration ---------------------------------------------------
  33. # If your documentation needs a minimal Sphinx version, state it here.
  34. #
  35. # needs_sphinx = '1.0'
  36. # Add any Sphinx extension module names here, as strings. They can be
  37. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  38. # ones.
  39. extensions = [
  40. "sphinx_automodapi.automodapi",
  41. "sphinx_automodapi.smart_resolver",
  42. "sphinx.ext.autodoc",
  43. "sphinx.ext.doctest",
  44. "sphinx.ext.inheritance_diagram",
  45. "sphinx.ext.intersphinx",
  46. "sphinx.ext.todo",
  47. "sphinx.ext.coverage",
  48. "sphinx.ext.imgmath",
  49. "sphinx.ext.ifconfig",
  50. "sphinx.ext.viewcode",
  51. "sphinx.ext.githubpages",
  52. "sphinx.ext.napoleon",
  53. ]
  54. # Add any paths that contain templates here, relative to this directory.
  55. templates_path = ["_templates"]
  56. # The suffix(es) of source filenames.
  57. # You can specify multiple suffix as a list of string:
  58. #
  59. # source_suffix = ['.rst', '.md']
  60. source_suffix = ".rst"
  61. # The master toctree document.
  62. master_doc = "index"
  63. # The language for content autogenerated by Sphinx. Refer to documentation
  64. # for a list of supported languages.
  65. #
  66. # This is also used if you do content translation via gettext catalogs.
  67. # Usually you set "language" from the command line for these cases.
  68. language = None
  69. # List of patterns, relative to source directory, that match files and
  70. # directories to ignore when looking for source files.
  71. # This pattern also affects html_static_path and html_extra_path.
  72. exclude_patterns = []
  73. # The name of the Pygments (syntax highlighting) style to use.
  74. pygments_style = "sphinx"
  75. # List of warnings to suppress when generating documentation.
  76. suppress_warnings = [
  77. "misc.highlighting_failure",
  78. "ref.doc",
  79. "ref.numref",
  80. "ref.ref",
  81. "toc.secnum",
  82. ]
  83. # -- Options for HTML output -------------------------------------------------
  84. # The theme to use for HTML and HTML Help pages. See the documentation for
  85. # a list of builtin themes.
  86. #
  87. html_theme = "alabaster"
  88. # Theme options are theme-specific and customize the look and feel of a theme
  89. # further. For a list of options available for each theme, see the
  90. # documentation.
  91. #
  92. # html_theme_options = {}
  93. # Add any paths that contain custom static files (such as style sheets) here,
  94. # relative to this directory. They are copied after the builtin static files,
  95. # so a file named "default.css" will overwrite the builtin "default.css".
  96. html_static_path = ["_static"]
  97. # Custom sidebar templates, must be a dictionary that maps document names
  98. # to template names.
  99. #
  100. # The default sidebars (for documents that don't match any pattern) are
  101. # defined by theme itself. Builtin themes are using these templates by
  102. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  103. # 'searchbox.html']``.
  104. #
  105. # html_sidebars = {}
  106. # -- Options for HTMLHelp output ---------------------------------------------
  107. # Output file base name for HTML help builder.
  108. htmlhelp_basename = "SharedMemoryDictionarydoc"
  109. # -- Options for LaTeX output ------------------------------------------------
  110. latex_elements = {
  111. # The paper size ('letterpaper' or 'a4paper').
  112. #
  113. # 'papersize': 'letterpaper',
  114. # The font size ('10pt', '11pt' or '12pt').
  115. #
  116. # 'pointsize': '10pt',
  117. # Additional stuff for the LaTeX preamble.
  118. #
  119. # 'preamble': '',
  120. # Latex figure (float) alignment
  121. #
  122. # 'figure_align': 'htbp',
  123. }
  124. # Grouping the document tree into LaTeX files. List of tuples
  125. # (source start file, target name, title,
  126. # author, documentclass [howto, manual, or own class]).
  127. latex_documents = [
  128. (
  129. master_doc,
  130. "SharedMemoryDictionary.tex",
  131. "Shared Memory Dictionary Documentation",
  132. "Nate Bohman",
  133. "manual",
  134. )
  135. ]
  136. # -- Options for manual page output ------------------------------------------
  137. # One entry per manual page. List of tuples
  138. # (source start file, name, description, authors, manual section).
  139. man_pages = [
  140. (master_doc, "shm_dict", "Shared Memory Dictionary Documentation", [author], 1)
  141. ]
  142. # -- Options for Texinfo output ----------------------------------------------
  143. # Grouping the document tree into Texinfo files. List of tuples
  144. # (source start file, target name, title, author,
  145. # dir menu entry, description, category)
  146. texinfo_documents = [
  147. (
  148. master_doc,
  149. "shm_dict",
  150. "Shared Memory Dictionary Documentation",
  151. author,
  152. "SharedMemoryDictionary",
  153. "Shared Memory Dictionary Documentation.",
  154. "Miscellaneous",
  155. )
  156. ]
  157. # -- Options for Epub output -------------------------------------------------
  158. # Bibliographic Dublin Core info.
  159. epub_title = project
  160. # The unique identifier of the text. This can be a ISBN number
  161. # or the project homepage.
  162. #
  163. # epub_identifier = ''
  164. # A unique identification for the text.
  165. #
  166. # epub_uid = ''
  167. # A list of files that should not be packed into the epub file.
  168. epub_exclude_files = ["search.html"]
  169. # -- Extension configuration -------------------------------------------------
  170. # -- Options for intersphinx extension ---------------------------------------
  171. # Example configuration for intersphinx: refer to the Python standard library.
  172. # The URL is the first tuple item. Check with
  173. # "python -m sphinx.ext.intersphinx 'URL/objects.inv'"
  174. # and use the second tuple item to specify the
  175. # name if not the default objects.inv
  176. intersphinx_mapping = {
  177. "arrow": ("https://arrow.readthedocs.io/en/latest/", None),
  178. "py2": ("https://docs.python.org/2", None),
  179. "py3": ("https://docs.python.org/3", None),
  180. "python": ("https://docs.python.org/3", None),
  181. "requests": ("http://docs.python-requests.org/en/master/", None),
  182. "six": ("https://six.readthedocs.io/", None),
  183. "urllib3": ("https://urllib3.readthedocs.io/en/latest/", None),
  184. }
  185. # -- Options for todo extension ----------------------------------------------
  186. # If true, `todo` and `todoList` produce output, else they produce nothing.
  187. todo_include_todos = True
  188. # -- Options for autodoc extension -------------------------------------------
  189. autodoc_default_options = {
  190. "member-order": "bysource",
  191. "special-members": "__init__",
  192. "exclude-members": "__weakref__",
  193. "show-inheritance": None,
  194. }
  195. # -- Options for automodapi extension ----------------------------------------
  196. # This is needed to avoid having methods and attributes of classes
  197. # being shown multiple times.
  198. numpydoc_show_class_members = False
  199. # If True, members that a class inherits from a base class are included
  200. # in the generated documentation.
  201. # automodsumm_inherited_members = False
  202. # -- Options for inheritance-graph extension ---------------------------------
  203. inheritance_graph_attrs = dict(
  204. fontsize=14, size=200, splines="spline", ratio="auto", rankdir="LR"
  205. )
  206. inheritance_node_attrs = dict(shape="ellipse", fontsize=14, height=0.75)
  207. # Add custom stylesheets
  208. def setup(app):
  209. app.add_stylesheet("css/coverage.css")