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 = 'Jp Project'
23+ copyright = '2018, Bruno Brito'
24+ author = 'Bruno Brito'
25+
26+ # The short X.Y version
27+ version = ''
28+ # The full version, including alpha/beta/rc tags
29+ release = '1.0.0'
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.autodoc' ,
43+ 'sphinx.ext.todo' ,
44+ 'sphinx.ext.imgmath' ,
45+ 'sphinx.ext.githubpages' ,
46+ ]
47+
48+ # Add any paths that contain templates here, relative to this directory.
49+ templates_path = ['ntemplates' ]
50+
51+ # The suffix(es) of source filenames.
52+ # You can specify multiple suffix as a list of string:
53+ #
54+ # source_suffix = ['.rst', '.md']
55+ from recommonmark .parser import CommonMarkParser
56+
57+ source_parsers = {
58+ '.md' : CommonMarkParser ,
59+ }
60+
61+ source_suffix = ['.rst' , '.md' ]
62+
63+
64+ # The master toctree document.
65+ master_doc = 'index'
66+
67+ # The language for content autogenerated by Sphinx. Refer to documentation
68+ # for a list of supported languages.
69+ #
70+ # This is also used if you do content translation via gettext catalogs.
71+ # Usually you set "language" from the command line for these cases.
72+ language = None
73+
74+ # List of patterns, relative to source directory, that match files and
75+ # directories to ignore when looking for source files.
76+ # This pattern also affects html_static_path and html_extra_path .
77+ exclude_patterns = []
78+
79+ # The name of the Pygments (syntax highlighting) style to use.
80+ pygments_style = 'sphinx'
81+
82+
83+ # -- Options for HTML output -------------------------------------------------
84+
85+ # The theme to use for HTML and HTML Help pages. See the documentation for
86+ # a list of builtin themes.
87+ #
88+ html_theme = 'alabaster'
89+
90+ # Theme options are theme-specific and customize the look and feel of a theme
91+ # further. For a list of options available for each theme, see the
92+ # documentation.
93+ #
94+ # html_theme_options = {}
95+
96+ # Add any paths that contain custom static files (such as style sheets) here,
97+ # relative to this directory. They are copied after the builtin static files,
98+ # so a file named "default.css" will overwrite the builtin "default.css".
99+ html_static_path = ['nstatic' ]
100+
101+ # Custom sidebar templates, must be a dictionary that maps document names
102+ # to template names.
103+ #
104+ # The default sidebars (for documents that don't match any pattern) are
105+ # defined by theme itself. Builtin themes are using these templates by
106+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
107+ # 'searchbox.html']``.
108+ #
109+ # html_sidebars = {}
110+
111+
112+ # -- Options for HTMLHelp output ---------------------------------------------
113+
114+ # Output file base name for HTML help builder.
115+ htmlhelp_basename = 'JpProjectdoc'
116+
117+
118+ # -- Options for LaTeX output ------------------------------------------------
119+
120+ latex_elements = {
121+ # The paper size ('letterpaper' or 'a4paper').
122+ #
123+ # 'papersize': 'letterpaper',
124+
125+ # The font size ('10pt', '11pt' or '12pt').
126+ #
127+ # 'pointsize': '10pt',
128+
129+ # Additional stuff for the LaTeX preamble.
130+ #
131+ # 'preamble': '',
132+
133+ # Latex figure (float) alignment
134+ #
135+ # 'figure_align': 'htbp',
136+ }
137+
138+ # Grouping the document tree into LaTeX files. List of tuples
139+ # (source start file, target name, title,
140+ # author, documentclass [howto, manual, or own class]).
141+ latex_documents = [
142+ (master_doc , 'JpProject.tex' , 'Jp Project Documentation' ,
143+ 'Bruno Brito' , 'manual' ),
144+ ]
145+
146+
147+ # -- Options for manual page output ------------------------------------------
148+
149+ # One entry per manual page. List of tuples
150+ # (source start file, name, description, authors, manual section).
151+ man_pages = [
152+ (master_doc , 'jpproject' , 'Jp Project Documentation' ,
153+ [author ], 1 )
154+ ]
155+
156+
157+ # -- Options for Texinfo output ----------------------------------------------
158+
159+ # Grouping the document tree into Texinfo files. List of tuples
160+ # (source start file, target name, title, author,
161+ # dir menu entry, description, category)
162+ texinfo_documents = [
163+ (master_doc , 'JpProject' , 'Jp Project Documentation' ,
164+ author , 'JpProject' , 'One line description of project.' ,
165+ 'Miscellaneous' ),
166+ ]
167+
168+
169+ # -- Extension configuration -------------------------------------------------
170+
171+ # -- Options for todo extension ----------------------------------------------
172+
173+ # If true, `todo` and `todoList` produce output, else they produce nothing.
174+ todo_include_todos = True
0 commit comments