1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3#
4# Lark documentation build configuration file, created by
5# sphinx-quickstart on Sun Aug 16 13:09:41 2020.
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#
20import os
21import sys
22sys.path.insert(0, os.path.abspath('..'))
23autodoc_member_order = 'bysource'
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 = [
36    'sphinx.ext.autodoc',
37    'sphinx.ext.napoleon',
38    'sphinx.ext.coverage',
39    'recommonmark',
40    'sphinx_markdown_tables',
41    'sphinx_gallery.gen_gallery'
42]
43
44# Add any paths that contain templates here, relative to this directory.
45templates_path = ['_templates']
46
47# The suffix(es) of source filenames.
48# You can specify multiple suffix as a list of string:
49#
50# source_suffix = ['.rst', '.md']
51source_suffix = {
52    '.rst': 'restructuredtext',
53    '.md': 'markdown'
54}
55
56
57# The master toctree document.
58master_doc = 'index'
59
60# General information about the project.
61project = 'Lark'
62copyright = '2020, Erez Shinan'
63author = 'Erez Shinan'
64
65# The version info for the project you're documenting, acts as replacement for
66# |version| and |release|, also used in various other places throughout the
67# built documents.
68#
69# The short X.Y version.
70version = ''
71# The full version, including alpha/beta/rc tags.
72release = ''
73
74# The language for content autogenerated by Sphinx. Refer to documentation
75# for a list of supported languages.
76#
77# This is also used if you do content translation via gettext catalogs.
78# Usually you set "language" from the command line for these cases.
79language = None
80
81# List of patterns, relative to source directory, that match files and
82# directories to ignore when looking for source files.
83# This patterns also effect to html_static_path and html_extra_path
84exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
85
86# The name of the Pygments (syntax highlighting) style to use.
87pygments_style = 'sphinx'
88
89# If true, `todo` and `todoList` produce output, else they produce nothing.
90todo_include_todos = False
91
92
93# -- Options for HTML output ----------------------------------------------
94
95# The theme to use for HTML and HTML Help pages.  See the documentation for
96# a list of builtin themes.
97#
98html_theme = 'sphinx_rtd_theme'
99
100# Theme options are theme-specific and customize the look and feel of a theme
101# further.  For a list of options available for each theme, see the
102# documentation.
103#
104# html_theme_options = {}
105
106# Add any paths that contain custom static files (such as style sheets) here,
107# relative to this directory. They are copied after the builtin static files,
108# so a file named "default.css" will overwrite the builtin "default.css".
109html_static_path = ['_static']
110
111# Custom sidebar templates, must be a dictionary that maps document names
112# to template names.
113#
114# This is required for the alabaster theme
115# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
116html_sidebars = {
117    '**': [
118        'relations.html',  # needs 'show_related': True theme option to display
119        'searchbox.html',
120    ]
121}
122
123
124# -- Options for HTMLHelp output ------------------------------------------
125
126# Output file base name for HTML help builder.
127htmlhelp_basename = 'Larkdoc'
128
129
130# -- Options for LaTeX output ---------------------------------------------
131
132latex_elements = {
133    # The paper size ('letterpaper' or 'a4paper').
134    #
135    # 'papersize': 'letterpaper',
136
137    # The font size ('10pt', '11pt' or '12pt').
138    #
139    # 'pointsize': '10pt',
140
141    # Additional stuff for the LaTeX preamble.
142    #
143    # 'preamble': '',
144
145    # Latex figure (float) alignment
146    #
147    # 'figure_align': 'htbp',
148}
149
150# Grouping the document tree into LaTeX files. List of tuples
151# (source start file, target name, title,
152#  author, documentclass [howto, manual, or own class]).
153latex_documents = [
154    (master_doc, 'Lark.tex', 'Lark Documentation',
155     'Erez Shinan', 'manual'),
156]
157
158
159# -- Options for manual page output ---------------------------------------
160
161# One entry per manual page. List of tuples
162# (source start file, name, description, authors, manual section).
163man_pages = [
164    (master_doc, 'lark', 'Lark Documentation',
165     [author], 7)
166]
167
168
169# -- Options for Texinfo output -------------------------------------------
170
171# Grouping the document tree into Texinfo files. List of tuples
172# (source start file, target name, title, author,
173#  dir menu entry, description, category)
174texinfo_documents = [
175    (master_doc, 'Lark', 'Lark Documentation',
176     author, 'Lark', 'One line description of project.',
177     'Miscellaneous'),
178]
179
180# -- Sphinx gallery config -------------------------------------------
181
182sphinx_gallery_conf = {
183    'examples_dirs': ['../examples'],
184    'gallery_dirs': ['examples'],
185}