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