1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3#
4# Neovim documentation build configuration file, created by
5# sphinx-quickstart on Sat Feb  3 12:15:22 2018.
6#
7# This file is execfile()d with the current directory set to its
8# containing dir.
9#
10# Note that not all possible configuration values are present in this
11# autogenerated file.
12#
13# All configuration values have a default; values that are commented out
14# serve to show the default.
15
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#
20# import os
21# import sys
22# sys.path.insert(0, os.path.abspath('./'))
23import datetime
24
25
26# -- General configuration ------------------------------------------------
27
28# If your documentation needs a minimal Sphinx version, state it here.
29#
30# needs_sphinx = '1.0'
31
32# Add any Sphinx extension module names here, as strings. They can be
33# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34# ones.
35extensions = ['sphinx.ext.autodoc',
36    'sphinx.ext.viewcode']
37
38# Add any paths that contain templates here, relative to this directory.
39templates_path = ['_templates']
40
41# The suffix(es) of source filenames.
42# You can specify multiple suffix as a list of string:
43#
44# source_suffix = ['.rst', '.md']
45source_suffix = '.rst'
46
47# The master toctree document.
48master_doc = 'index'
49
50# General information about the project.
51project = 'Neovim Python Client'
52copyright = '2014 - {year}, Neovim'.format(
53    year=datetime.datetime.now().year
54)
55author = 'Neovim'
56
57# The version info for the project you're documenting, acts as replacement for
58# |version| and |release|, also used in various other places throughout the
59# built documents.
60#
61# The short X.Y version.
62version = ''
63# The full version, including alpha/beta/rc tags.
64release = ''
65
66# The language for content autogenerated by Sphinx. Refer to documentation
67# for a list of supported languages.
68#
69# This is also used if you do content translation via gettext catalogs.
70# Usually you set "language" from the command line for these cases.
71language = None
72
73# List of patterns, relative to source directory, that match files and
74# directories to ignore when looking for source files.
75# This patterns also effect to html_static_path and html_extra_path
76exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
77
78# The name of the Pygments (syntax highlighting) style to use.
79pygments_style = 'sphinx'
80
81# If true, `todo` and `todoList` produce output, else they produce nothing.
82todo_include_todos = False
83
84
85# -- Options for HTML output ----------------------------------------------
86
87# The theme to use for HTML and HTML Help pages.  See the documentation for
88# a list of builtin themes.
89#
90html_theme = 'sphinx_rtd_theme'
91
92# Theme options are theme-specific and customize the look and feel of a theme
93# further.  For a list of options available for each theme, see the
94# documentation.
95#
96# html_theme_options = {}
97
98# Add any paths that contain custom static files (such as style sheets) here,
99# relative to this directory. They are copied after the builtin static files,
100# so a file named "default.css" will overwrite the builtin "default.css".
101html_static_path = []
102
103
104# -- Options for HTMLHelp output ------------------------------------------
105
106# Output file base name for HTML help builder.
107htmlhelp_basename = 'Neovimdoc'
108
109
110# -- Options for LaTeX output ---------------------------------------------
111
112latex_elements = {
113    # The paper size ('letterpaper' or 'a4paper').
114    #
115    # 'papersize': 'letterpaper',
116
117    # The font size ('10pt', '11pt' or '12pt').
118    #
119    # 'pointsize': '10pt',
120
121    # Additional stuff for the LaTeX preamble.
122    #
123    # 'preamble': '',
124
125    # Latex figure (float) alignment
126    #
127    # 'figure_align': 'htbp',
128}
129
130# Grouping the document tree into LaTeX files. List of tuples
131# (source start file, target name, title,
132#  author, documentclass [howto, manual, or own class]).
133latex_documents = [
134    (master_doc, 'Neovim.tex', 'Neovim Documentation',
135     'Neovim', 'manual'),
136]
137
138
139# -- Options for manual page output ---------------------------------------
140
141# One entry per manual page. List of tuples
142# (source start file, name, description, authors, manual section).
143man_pages = [
144    (master_doc, 'neovim', 'Neovim Documentation',
145     [author], 1)
146]
147
148
149# -- Options for Texinfo output -------------------------------------------
150
151# Grouping the document tree into Texinfo files. List of tuples
152# (source start file, target name, title, author,
153#  dir menu entry, description, category)
154texinfo_documents = [
155    (master_doc, 'Neovim', 'Neovim Documentation',
156     author, 'Neovim', 'One line description of project.',
157     'Miscellaneous'),
158]
159
160
161
162