gtsam/3rdparty/GeographicLib/python/doc/conf.py
Go to the documentation of this file.
1 # -*- coding: utf-8 -*-
2 #
3 # geographiclib documentation build configuration file, created by
4 # sphinx-quickstart on Sat Oct 24 17:14:00 2015.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14 
15 import sys
16 import os
17 import sphinx
18 sys.path.insert(0, os.path.abspath('..'))
19 import geographiclib
27 
28 # If extensions (or modules to document with autodoc) are in another directory,
29 # add these directories to sys.path here. If the directory is relative to the
30 # documentation root, use os.path.abspath to make it absolute, like shown here.
31 #sys.path.insert(0, os.path.abspath('.'))
32 
33 # -- General configuration ------------------------------------------------
34 
35 # If your documentation needs a minimal Sphinx version, state it here.
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.viewcode',
44 ]
45 
46 # Add any paths that contain templates here, relative to this directory.
47 #templates_path = ['_templates']
48 
49 # The suffix of source filenames.
50 source_suffix = '.rst'
51 
52 # The encoding of source files.
53 #source_encoding = 'utf-8-sig'
54 
55 # The master toctree document.
56 master_doc = 'index'
57 
58 # General information about the project.
59 project = u'geographiclib'
60 copyright = u'2015, Charles Karney'
61 
62 # The version info for the project you're documenting, acts as replacement for
63 # |version| and |release|, also used in various other places throughout the
64 # built documents.
65 #
66 # The short X.Y version.
67 version = geographiclib.__version__
68 # The full version, including alpha/beta/rc tags.
69 release = version
70 
71 # The language for content autogenerated by Sphinx. Refer to documentation
72 # for a list of supported languages.
73 #language = None
74 
75 # There are two options for replacing |today|: either, you set today to some
76 # non-false value, then it is used:
77 #today = ''
78 # Else, today_fmt is used as the format for a strftime call.
79 #today_fmt = '%B %d, %Y'
80 
81 # List of patterns, relative to source directory, that match files and
82 # directories to ignore when looking for source files.
83 #exclude_patterns = ['_build']
84 
85 # The reST default role (used for this markup: `text`) to use for all
86 # documents.
87 #default_role = None
88 
89 # If true, '()' will be appended to :func: etc. cross-reference text.
90 #add_function_parentheses = True
91 
92 # If true, the current module name will be prepended to all description
93 # unit titles (such as .. function::).
94 #add_module_names = True
95 
96 # If true, sectionauthor and moduleauthor directives will be shown in the
97 # output. They are ignored by default.
98 #show_authors = False
99 
100 # The name of the Pygments (syntax highlighting) style to use.
101 pygments_style = 'sphinx'
102 
103 # A list of ignored prefixes for module index sorting.
104 #modindex_common_prefix = []
105 
106 # If true, keep warnings as "system message" paragraphs in the built documents.
107 #keep_warnings = False
108 
109 # -- Options for HTML output ----------------------------------------------
110 
111 # The theme to use for HTML and HTML Help pages. See the documentation for
112 # a list of builtin themes.
113 html_theme = 'default' if sphinx.__version__ < '1.3' else 'classic'
114 
115 # Theme options are theme-specific and customize the look and feel of a theme
116 # further. For a list of options available for each theme, see the
117 # documentation.
118 #html_theme_options = {}
119 
120 # Add any paths that contain custom themes here, relative to this directory.
121 #html_theme_path = []
122 
123 # The name for this set of Sphinx documents. If None, it defaults to
124 # "<project> v<release> documentation".
125 #html_title = None
126 
127 # A shorter title for the navigation bar. Default is the same as html_title.
128 #html_short_title = None
129 
130 # The name of an image file (relative to this directory) to place at the top
131 # of the sidebar.
132 #html_logo = None
133 
134 # The name of an image file (within the static path) to use as favicon of the
135 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
136 # pixels large.
137 #html_favicon = None
138 
139 # Add any paths that contain custom static files (such as style sheets) here,
140 # relative to this directory. They are copied after the builtin static files,
141 # so a file named "default.css" will overwrite the builtin "default.css".
142 #html_static_path = ['_static']
143 
144 # Add any extra paths that contain custom files (such as robots.txt or
145 # .htaccess) here, relative to this directory. These files are copied
146 # directly to the root of the documentation.
147 #html_extra_path = []
148 
149 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
150 # using the given strftime format.
151 #html_last_updated_fmt = '%b %d, %Y'
152 
153 # If true, SmartyPants will be used to convert quotes and dashes to
154 # typographically correct entities.
155 #html_use_smartypants = True
156 
157 # Custom sidebar templates, maps document names to template names.
158 #html_sidebars = {}
159 
160 # Additional templates that should be rendered to pages, maps page names to
161 # template names.
162 #html_additional_pages = {}
163 
164 # If false, no module index is generated.
165 #html_domain_indices = True
166 
167 # If false, no index is generated.
168 #html_use_index = True
169 
170 # If true, the index is split into individual pages for each letter.
171 #html_split_index = False
172 
173 # If true, links to the reST sources are added to the pages.
174 #html_show_sourcelink = True
175 
176 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
177 #html_show_sphinx = True
178 
179 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
180 #html_show_copyright = True
181 
182 # If true, an OpenSearch description file will be output, and all pages will
183 # contain a <link> tag referring to it. The value of this option must be the
184 # base URL from which the finished HTML is served.
185 #html_use_opensearch = ''
186 
187 # This is the file name suffix for HTML files (e.g. ".xhtml").
188 #html_file_suffix = None
189 
190 # Output file base name for HTML help builder.
191 htmlhelp_basename = 'geographiclibdoc'
192 
193 # -- Options for LaTeX output ---------------------------------------------
194 
195 latex_elements = {
196 # The paper size ('letterpaper' or 'a4paper').
197 #'papersize': 'letterpaper',
198 
199 # The font size ('10pt', '11pt' or '12pt').
200 #'pointsize': '10pt',
201 
202 # Additional stuff for the LaTeX preamble.
203 #'preamble': '',
204 }
205 
206 # Grouping the document tree into LaTeX files. List of tuples
207 # (source start file, target name, title,
208 # author, documentclass [howto, manual, or own class]).
209 latex_documents = [
210  ('index', 'geographiclib.tex', u'geographiclib Documentation',
211  u'Charles Karney', 'manual'),
212 ]
213 
214 # The name of an image file (relative to this directory) to place at the top of
215 # the title page.
216 #latex_logo = None
217 
218 # For "manual" documents, if this is true, then toplevel headings are parts,
219 # not chapters.
220 #latex_use_parts = False
221 
222 # If true, show page references after internal links.
223 #latex_show_pagerefs = False
224 
225 # If true, show URL addresses after external links.
226 #latex_show_urls = False
227 
228 # Documents to append as an appendix to all manuals.
229 #latex_appendices = []
230 
231 # If false, no module index is generated.
232 #latex_domain_indices = True
233 
234 # -- Options for manual page output ---------------------------------------
235 
236 # One entry per manual page. List of tuples
237 # (source start file, name, description, authors, manual section).
238 man_pages = [
239  ('index', 'geographiclib', u'geographiclib Documentation',
240  [u'Charles Karney'], 1)
241 ]
242 
243 # If true, show URL addresses after external links.
244 #man_show_urls = False
245 
246 # -- Options for Texinfo output -------------------------------------------
247 
248 # Grouping the document tree into Texinfo files. List of tuples
249 # (source start file, target name, title, author,
250 # dir menu entry, description, category)
251 texinfo_documents = [
252  ('index', 'geographiclib', u'geographiclib Documentation',
253  u'Charles Karney', 'geographiclib', 'One line description of project.',
254  'Miscellaneous'),
255 ]
256 
257 # Documents to append as an appendix to all manuals.
258 #texinfo_appendices = []
259 
260 # If false, no module index is generated.
261 #texinfo_domain_indices = True
262 
263 # How to display URL addresses: 'footnote', 'no', or 'inline'.
264 #texinfo_show_urls = 'footnote'
265 
266 # If true, do not generate a @detailmenu in the "Top" node's menu.
267 #texinfo_no_detailmenu = False
268 
269 autodoc_member_order = 'bysource'
270 
271 autoclass_content = 'both'


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:34:03