1+ # -*- coding: utf-8 -*-
2+ #
3+ # Configuration file for the Sphinx documentation builder.
4+ #
5+ # This file does only contain a selection of the most common options. For a
6+ # full list see the documentation:
7+ # http://www.sphinx-doc.org/en/master/config
8+
9+ # -- Path setup --------------------------------------------------------------
10+
11+ # If extensions (or modules to document with autodoc) are in another directory,
12+ # add these directories to sys.path here. If the directory is relative to the
13+ # documentation root, use os.path.abspath to make it absolute, like shown here.
14+ #
15+ # import os
16+ # import sys
17+ # sys.path.insert(0, os.path.abspath('.'))
18+
19+
20+ # -- Project information -----------------------------------------------------
21+
22+ project = 'Avalon Programming Language'
23+ copyright = '2018, Ntwali Bashige'
24+ author = 'Ntwali Bashige'
25+
26+ # The short X.Y version
27+ version = ''
28+ # The full version, including alpha/beta/rc tags
29+ release = '0.0.1'
30+
31+
32+ # -- General configuration ---------------------------------------------------
33+
34+ # If your documentation needs a minimal Sphinx version, state it here.
35+ #
36+ # needs_sphinx = '1.0'
37+
38+ # Add any Sphinx extension module names here, as strings. They can be
39+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+ # ones.
41+ extensions = [
42+ 'sphinx.ext.intersphinx' ,
43+ 'sphinx.ext.mathjax' ,
44+ 'sphinx.ext.ifconfig' ,
45+ 'sphinx.ext.githubpages' ,
46+ 'rinoh.frontend.sphinx' ,
47+ ]
48+
49+ # Add any paths that contain templates here, relative to this directory.
50+ templates_path = ['_templates' ]
51+
52+ # The suffix(es) of source filenames.
53+ # You can specify multiple suffix as a list of string:
54+ #
55+ # source_suffix = ['.rst', '.md']
56+ source_suffix = '.rst'
57+
58+ # The master toctree document.
59+ master_doc = 'index'
60+
61+ # The language for content autogenerated by Sphinx. Refer to documentation
62+ # for a list of supported languages.
63+ #
64+ # This is also used if you do content translation via gettext catalogs.
65+ # Usually you set "language" from the command line for these cases.
66+ language = None
67+
68+ # List of patterns, relative to source directory, that match files and
69+ # directories to ignore when looking for source files.
70+ # This pattern also affects html_static_path and html_extra_path.
71+ exclude_patterns = []
72+
73+ # The name of the Pygments (syntax highlighting) style to use.
74+ pygments_style = None
75+
76+
77+ # -- Options for HTML output -------------------------------------------------
78+
79+ # The theme to use for HTML and HTML Help pages. See the documentation for
80+ # a list of builtin themes.
81+ #
82+ html_theme = 'default'
83+
84+ # Theme options are theme-specific and customize the look and feel of a theme
85+ # further. For a list of options available for each theme, see the
86+ # documentation.
87+ #
88+ # html_theme_options = {}
89+
90+ # Add any paths that contain custom static files (such as style sheets) here,
91+ # relative to this directory. They are copied after the builtin static files,
92+ # so a file named "default.css" will overwrite the builtin "default.css".
93+ html_static_path = ['_static' ]
94+
95+ # Custom sidebar templates, must be a dictionary that maps document names
96+ # to template names.
97+ #
98+ # The default sidebars (for documents that don't match any pattern) are
99+ # defined by theme itself. Builtin themes are using these templates by
100+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
101+ # 'searchbox.html']``.
102+ #
103+ # html_sidebars = {}
104+
105+
106+ # -- Options for HTMLHelp output ---------------------------------------------
107+
108+ # Output file base name for HTML help builder.
109+ htmlhelp_basename = 'avalon-doc'
110+
111+
112+ # -- Options for LaTeX output ------------------------------------------------
113+
114+ latex_elements = {
115+ # The paper size ('letterpaper' or 'a4paper').
116+ #
117+ 'papersize' : 'letterpaper' ,
118+
119+ # The font size ('10pt', '11pt' or '12pt').
120+ #
121+ 'pointsize' : '10pt' ,
122+
123+ # Additional stuff for the LaTeX preamble.
124+ #
125+ 'preamble' : '' ,
126+
127+ # Latex figure (float) alignment
128+ #
129+ 'figure_align' : 'htbp' ,
130+ }
131+
132+ # Grouping the document tree into LaTeX files. List of tuples
133+ # (source start file, target name, title,
134+ # author, documentclass [howto, manual, or own class]).
135+ latex_documents = [
136+ (master_doc , 'avalon-lang.tex' , 'Avalon Programming Language Documentation' ,
137+ 'Ntwali Bashige' , 'manual' ),
138+ ]
139+
140+
141+ # -- Options for manual page output ------------------------------------------
142+
143+ # One entry per manual page. List of tuples
144+ # (source start file, name, description, authors, manual section).
145+ man_pages = [
146+ (master_doc , 'avalonprogramminglanguage' , 'Avalon Programming Language Documentation' ,
147+ [author ], 1 )
148+ ]
149+
150+
151+ # -- Options for Texinfo output ----------------------------------------------
152+
153+ # Grouping the document tree into Texinfo files. List of tuples
154+ # (source start file, target name, title, author,
155+ # dir menu entry, description, category)
156+ texinfo_documents = [
157+ (master_doc , 'avalon-lang' , 'Avalon Programming Language Documentation' ,
158+ author , 'avalon-lang' , 'One line description of project.' ,
159+ 'Miscellaneous' ),
160+ ]
161+
162+
163+ # -- Options for Epub output -------------------------------------------------
164+
165+ # Bibliographic Dublin Core info.
166+ epub_title = project
167+
168+ # The unique identifier of the text. This can be a ISBN number
169+ # or the project homepage.
170+ #
171+ # epub_identifier = ''
172+
173+ # A unique identification for the text.
174+ #
175+ # epub_uid = ''
176+
177+ # A list of files that should not be packed into the epub file.
178+ epub_exclude_files = ['search.html' ]
179+
180+
181+ # -- Extension configuration -------------------------------------------------
182+
183+ # -- Options for intersphinx extension ---------------------------------------
184+
185+ # Example configuration for intersphinx: refer to the Python standard library.
186+ intersphinx_mapping = {'https://docs.python.org/' : None }
0 commit comments