FreeCAD

1
# -*- coding: utf-8 -*-
2

3
#***************************************************************************
4
#*                                                                         *
5
#*   Copyright (c) 2012                                                    *
6
#*   Yorik van Havre <yorik@uncreated.net>                                 *
7
#*                                                                         *
8
#*   This program is free software; you can redistribute it and/or modify  *
9
#*   it under the terms of the GNU Lesser General Public License (LGPL)    *
10
#*   as published by the Free Software Foundation; either version 2 of     *
11
#*   the License, or (at your option) any later version.                   *
12
#*   for detail see the LICENCE text file.                                 *
13
#*                                                                         *
14
#*   This program is distributed in the hope that it will be useful,       *
15
#*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
16
#*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
17
#*   GNU Library General Public License for more details.                  *
18
#*                                                                         *
19
#*   You should have received a copy of the GNU Library General Public     *
20
#*   License along with this program; if not, write to the Free Software   *
21
#*   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
22
#*   USA                                                                   *
23
#*                                                                         *
24
#***************************************************************************
25

26
#
27
# FreeCAD documentation build configuration file, created by
28
# sphinx-quickstart on Wed Nov 30 10:49:09 2011.
29
#
30
# This file is execfile()d with the current directory set to its containing dir.
31
#
32
# Note that not all possible configuration values are present in this
33
# autogenerated file.
34
#
35
# All configuration values have a default; values that are commented out
36
# serve to show the default.
37

38
import sys, os, commands
39

40
# If extensions (or modules to document with autodoc) are in another directory,
41
# add these directories to sys.path here. If the directory is relative to the
42
# documentation root, use os.path.abspath to make it absolute, like shown here.
43
#sys.path.insert(0, os.path.abspath('.'))
44

45
# first look for local (home-compiled) FreeCAD in its default location:
46

47
if os.path.exists(os.path.abspath(os.path.join(os.environ["HOME"],"FreeCAD/lib"))):
48
    sys.path.append(os.path.abspath(os.path.join(os.environ["HOME"],"FreeCAD/lib")))
49

50
# otherwise try to locate FreeCAD lib somewhere else:
51

52
elif commands.getstatusoutput("locate FreeCAD/lib")[0] == 0:
53
    path = commands.getstatusoutput("locate FreeCAD/lib")[1].split()[0]
54
    sys.path.append(path)
55

56
# locate TemplatePyMod
57
if commands.getstatusoutput("locate TemplatePyMod")[0] == 0:
58
    path = commands.getstatusoutput("locate TemplatePyMod")[1].split()[0]
59
    sys.path.append(path)
60

61
import FreeCAD, FreeCADGui
62
FreeCADGui.showMainWindow() # this is needed for complete import of GUI modules
63
doc = FreeCAD.newDocument("doc")
64

65
# -- General configuration -----------------------------------------------------
66

67
# If your documentation needs a minimal Sphinx version, state it here.
68
#needs_sphinx = '1.0'
69

70
# Add any Sphinx extension module names here, as strings. They can be extensions
71
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
72
extensions = ['sphinx.ext.autodoc']
73

74
# Add any paths that contain templates here, relative to this directory.
75
templates_path = ['_templates']
76

77
# The suffix of source filenames.
78
source_suffix = '.rst'
79

80
# The encoding of source files.
81
#source_encoding = 'utf-8-sig'
82

83
# The master toctree document.
84
master_doc = 'index'
85

86
# General information about the project.
87
project = u'FreeCAD'
88
copyright = u'2013, Jürgen Riegel, Werner Mayer, Yorik van Havre'
89

90
# The version info for the project you're documenting, acts as replacement for
91
# |version| and |release|, also used in various other places throughout the
92
# built documents.
93
#
94
# The short X.Y version.
95
version = '0.14'
96
# The full version, including alpha/beta/rc tags.
97
release = '0.14'
98

99
# The language for content autogenerated by Sphinx. Refer to documentation
100
# for a list of supported languages.
101
#language = None
102

103
# There are two options for replacing |today|: either, you set today to some
104
# non-false value, then it is used:
105
#today = ''
106
# Else, today_fmt is used as the format for a strftime call.
107
#today_fmt = '%B %d, %Y'
108

109
# List of patterns, relative to source directory, that match files and
110
# directories to ignore when looking for source files.
111
exclude_patterns = ['_build']
112

113
# The reST default role (used for this markup: `text`) to use for all documents.
114
#default_role = None
115

116
# If true, '()' will be appended to :func: etc. cross-reference text.
117
#add_function_parentheses = True
118

119
# If true, the current module name will be prepended to all description
120
# unit titles (such as .. function::).
121
add_module_names = False
122

123
# If true, sectionauthor and moduleauthor directives will be shown in the
124
# output. They are ignored by default.
125
#show_authors = False
126

127
# The name of the Pygments (syntax highlighting) style to use.
128
pygments_style = 'sphinx'
129

130
# A list of ignored prefixes for module index sorting.
131
#modindex_common_prefix = []
132

133

134
# -- Options for HTML output ---------------------------------------------------
135

136
# The theme to use for HTML and HTML Help pages.  See the documentation for
137
# a list of builtin themes.
138
html_theme = 'default'
139

140
html_style = 'freecad.css'
141

142
# Theme options are theme-specific and customize the look and feel of a theme
143
# further.  For a list of options available for each theme, see the
144
# documentation.
145
#html_theme_options = {}
146

147
# Add any paths that contain custom themes here, relative to this directory.
148
#html_theme_path = []
149

150
# The name for this set of Sphinx documents.  If None, it defaults to
151
# "<project> v<release> documentation".
152
html_title = "FreeCAD API documentation"
153

154
# A shorter title for the navigation bar.  Default is the same as html_title.
155
#html_short_title = None
156

157
# The name of an image file (relative to this directory) to place at the top
158
# of the sidebar.
159
#html_logo = None
160

161
# The name of an image file (within the static path) to use as favicon of the
162
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
163
# pixels large.
164
html_favicon = "favicon.ico"
165

166
# Add any paths that contain custom static files (such as style sheets) here,
167
# relative to this directory. They are copied after the builtin static files,
168
# so a file named "default.css" will overwrite the builtin "default.css".
169
html_static_path = ['_static']
170

171
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
172
# using the given strftime format.
173
#html_last_updated_fmt = '%b %d, %Y'
174

175
# If true, SmartyPants will be used to convert quotes and dashes to
176
# typographically correct entities.
177
#html_use_smartypants = True
178

179
# Custom sidebar templates, maps document names to template names.
180
# html_sidebars = {}
181

182
# Additional templates that should be rendered to pages, maps page names to
183
# template names.
184
# html_additional_pages = {}
185

186
# If false, no module index is generated.
187
#html_domain_indices = True
188

189
# If false, no index is generated.
190
#html_use_index = True
191

192
# If true, the index is split into individual pages for each letter.
193
#html_split_index = False
194

195
# If true, links to the reST sources are added to the pages.
196
#html_show_sourcelink = True
197

198
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
199
#html_show_sphinx = True
200

201
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
202
#html_show_copyright = True
203

204
# If true, an OpenSearch description file will be output, and all pages will
205
# contain a <link> tag referring to it.  The value of this option must be the
206
# base URL from which the finished HTML is served.
207
#html_use_opensearch = ''
208

209
# This is the file name suffix for HTML files (e.g. ".xhtml").
210
#html_file_suffix = None
211

212
# Output file base name for HTML help builder.
213
htmlhelp_basename = 'FreeCADdoc'
214

215

216
# -- Options for LaTeX output --------------------------------------------------
217

218
# The paper size ('letter' or 'a4').
219
#latex_paper_size = 'letter'
220

221
# The font size ('10pt', '11pt' or '12pt').
222
#latex_font_size = '10pt'
223

224
# Grouping the document tree into LaTeX files. List of tuples
225
# (source start file, target name, title, author, documentclass [howto/manual]).
226
latex_documents = [
227
  ('index', 'FreeCAD.tex', u'FreeCAD Documentation',
228
   u'Jürgen Riegel, Werner Mayer,Yorik van Havre', 'manual'),
229
]
230

231
# The name of an image file (relative to this directory) to place at the top of
232
# the title page.
233
#latex_logo = None
234

235
# For "manual" documents, if this is true, then toplevel headings are parts,
236
# not chapters.
237
#latex_use_parts = False
238

239
# If true, show page references after internal links.
240
#latex_show_pagerefs = False
241

242
# If true, show URL addresses after external links.
243
#latex_show_urls = False
244

245
# Additional stuff for the LaTeX preamble.
246
#latex_preamble = ''
247

248
# Documents to append as an appendix to all manuals.
249
#latex_appendices = []
250

251
# If false, no module index is generated.
252
#latex_domain_indices = True
253

254

255
# -- Options for manual page output --------------------------------------------
256

257
# One entry per manual page. List of tuples
258
# (source start file, name, description, authors, manual section).
259
man_pages = [
260
    ('index', 'freecad', u'FreeCAD Documentation',
261
     [u'Jürgen Riegel, Werner Mayer, Yorik van Havre'], 1)
262
]
263