[5331] | 1 | # -*- coding: utf-8 -*- |
---|
| 2 | # |
---|
[7818] | 3 | # WAeUP Student Information and Registration Portal (Kofa) documentation build configuration file, created by |
---|
[5331] | 4 | # sphinx-quickstart on Thu Jul 29 10:41:59 2010. |
---|
| 5 | # |
---|
| 6 | # This file is execfile()d with the current directory set to its containing dir. |
---|
| 7 | # |
---|
| 8 | # Note that not all possible configuration values are present in this |
---|
| 9 | # autogenerated file. |
---|
| 10 | # |
---|
| 11 | # All configuration values have a default; values that are commented out |
---|
| 12 | # serve to show the default. |
---|
| 13 | |
---|
| 14 | import sys, os |
---|
| 15 | import pkg_resources |
---|
| 16 | |
---|
| 17 | # If extensions (or modules to document with autodoc) are in another directory, |
---|
| 18 | # add these directories to sys.path here. If the directory is relative to the |
---|
| 19 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
---|
| 20 | #sys.path.append(os.path.abspath('.')) |
---|
| 21 | |
---|
| 22 | # -- General configuration ----------------------------------------------------- |
---|
| 23 | |
---|
| 24 | # Add any Sphinx extension module names here, as strings. They can be extensions |
---|
| 25 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
---|
[5662] | 26 | extensions = [ |
---|
| 27 | 'sphinx.ext.autodoc', |
---|
| 28 | 'sphinx.ext.doctest', |
---|
| 29 | 'sphinx.ext.intersphinx', |
---|
| 30 | 'sphinx.ext.todo', |
---|
| 31 | 'sphinx.ext.coverage', |
---|
| 32 | 'sphinx.ext.ifconfig', |
---|
| 33 | 'sphinx.ext.viewcode', |
---|
| 34 | 'repoze.sphinx.autointerface' |
---|
| 35 | ] |
---|
[5331] | 36 | |
---|
| 37 | # Add any paths that contain templates here, relative to this directory. |
---|
| 38 | templates_path = ['_templates'] |
---|
| 39 | |
---|
| 40 | # The suffix of source filenames. |
---|
| 41 | source_suffix = '.rst' |
---|
| 42 | |
---|
| 43 | # The encoding of source files. |
---|
| 44 | #source_encoding = 'utf-8' |
---|
| 45 | |
---|
| 46 | # The master toctree document. |
---|
| 47 | master_doc = 'index' |
---|
| 48 | |
---|
| 49 | # General information about the project. |
---|
[7818] | 50 | project = u'WAeUP.Kofa' |
---|
[5662] | 51 | copyright = u'2011, WAeUP Team' |
---|
[5331] | 52 | |
---|
| 53 | # The version info for the project you're documenting, acts as replacement for |
---|
| 54 | # |version| and |release|, also used in various other places throughout the |
---|
| 55 | # built documents. |
---|
| 56 | # |
---|
| 57 | # The short X.Y version. |
---|
[7808] | 58 | version = pkg_resources.get_distribution('waeup.kofa').version |
---|
[5331] | 59 | #version = '0.2dev' |
---|
| 60 | # The full version, including alpha/beta/rc tags. |
---|
| 61 | #release = '0.2dev' |
---|
| 62 | release = version |
---|
| 63 | |
---|
| 64 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
| 65 | # for a list of supported languages. |
---|
| 66 | #language = None |
---|
| 67 | |
---|
| 68 | # There are two options for replacing |today|: either, you set today to some |
---|
| 69 | # non-false value, then it is used: |
---|
| 70 | #today = '' |
---|
| 71 | # Else, today_fmt is used as the format for a strftime call. |
---|
| 72 | #today_fmt = '%B %d, %Y' |
---|
| 73 | |
---|
| 74 | # List of documents that shouldn't be included in the build. |
---|
| 75 | #unused_docs = [] |
---|
| 76 | |
---|
| 77 | # List of directories, relative to source directory, that shouldn't be searched |
---|
| 78 | # for source files. |
---|
| 79 | exclude_trees = [] |
---|
| 80 | |
---|
| 81 | # The reST default role (used for this markup: `text`) to use for all documents. |
---|
| 82 | #default_role = None |
---|
| 83 | |
---|
| 84 | # If true, '()' will be appended to :func: etc. cross-reference text. |
---|
| 85 | #add_function_parentheses = True |
---|
| 86 | |
---|
| 87 | # If true, the current module name will be prepended to all description |
---|
| 88 | # unit titles (such as .. function::). |
---|
| 89 | #add_module_names = True |
---|
| 90 | |
---|
| 91 | # If true, sectionauthor and moduleauthor directives will be shown in the |
---|
| 92 | # output. They are ignored by default. |
---|
| 93 | #show_authors = False |
---|
| 94 | |
---|
| 95 | # The name of the Pygments (syntax highlighting) style to use. |
---|
| 96 | pygments_style = 'sphinx' |
---|
| 97 | |
---|
| 98 | # A list of ignored prefixes for module index sorting. |
---|
| 99 | #modindex_common_prefix = [] |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | # -- Options for HTML output --------------------------------------------------- |
---|
| 103 | |
---|
| 104 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
---|
| 105 | # Sphinx are currently 'default' and 'sphinxdoc'. |
---|
[12860] | 106 | #html_theme = 'sphinx_rtd_theme' |
---|
| 107 | html_theme = 'sphinxdoc' |
---|
[5331] | 108 | |
---|
| 109 | # Theme options are theme-specific and customize the look and feel of a theme |
---|
| 110 | # further. For a list of options available for each theme, see the |
---|
| 111 | # documentation. |
---|
| 112 | #html_theme_options = {} |
---|
| 113 | |
---|
| 114 | # Add any paths that contain custom themes here, relative to this directory. |
---|
| 115 | #html_theme_path = [] |
---|
| 116 | |
---|
| 117 | # The name for this set of Sphinx documents. If None, it defaults to |
---|
| 118 | # "<project> v<release> documentation". |
---|
[12863] | 119 | html_title = "%s %s Documentation" % (project, release) |
---|
[5331] | 120 | |
---|
| 121 | # A shorter title for the navigation bar. Default is the same as html_title. |
---|
| 122 | #html_short_title = None |
---|
| 123 | |
---|
| 124 | # The name of an image file (relative to this directory) to place at the top |
---|
| 125 | # of the sidebar. |
---|
| 126 | #html_logo = None |
---|
| 127 | |
---|
| 128 | # The name of an image file (within the static path) to use as favicon of the |
---|
| 129 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
---|
| 130 | # pixels large. |
---|
| 131 | #html_favicon = None |
---|
[12851] | 132 | html_favicon = "_static/favicon.ico" |
---|
[5331] | 133 | |
---|
| 134 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
| 135 | # relative to this directory. They are copied after the builtin static files, |
---|
| 136 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
| 137 | html_static_path = ['_static'] |
---|
| 138 | |
---|
| 139 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
---|
| 140 | # using the given strftime format. |
---|
| 141 | #html_last_updated_fmt = '%b %d, %Y' |
---|
| 142 | |
---|
| 143 | # If true, SmartyPants will be used to convert quotes and dashes to |
---|
| 144 | # typographically correct entities. |
---|
| 145 | #html_use_smartypants = True |
---|
| 146 | |
---|
| 147 | # Custom sidebar templates, maps document names to template names. |
---|
| 148 | #html_sidebars = {} |
---|
| 149 | |
---|
| 150 | # Additional templates that should be rendered to pages, maps page names to |
---|
| 151 | # template names. |
---|
| 152 | #html_additional_pages = {} |
---|
| 153 | #html_additional_pages = { |
---|
| 154 | # 'index': os.path.join(os.path.dirname(__file__), 'docindex.template')} |
---|
| 155 | html_additional_pages = { 'index': 'mainpage.template'} |
---|
| 156 | # If false, no module index is generated. |
---|
| 157 | #html_use_modindex = True |
---|
| 158 | |
---|
| 159 | # If false, no index is generated. |
---|
| 160 | #html_use_index = True |
---|
| 161 | |
---|
| 162 | # If true, the index is split into individual pages for each letter. |
---|
| 163 | #html_split_index = False |
---|
| 164 | |
---|
| 165 | # If true, links to the reST sources are added to the pages. |
---|
| 166 | #html_show_sourcelink = True |
---|
| 167 | |
---|
| 168 | # If true, an OpenSearch description file will be output, and all pages will |
---|
| 169 | # contain a <link> tag referring to it. The value of this option must be the |
---|
| 170 | # base URL from which the finished HTML is served. |
---|
| 171 | #html_use_opensearch = '' |
---|
| 172 | |
---|
| 173 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
---|
| 174 | #html_file_suffix = '' |
---|
| 175 | |
---|
| 176 | # Output file base name for HTML help builder. |
---|
[7818] | 177 | htmlhelp_basename = 'WAeUPStudentInformationandRegistrationPortalKofadoc' |
---|
[5331] | 178 | |
---|
| 179 | |
---|
| 180 | # -- Options for LaTeX output -------------------------------------------------- |
---|
| 181 | |
---|
| 182 | # The paper size ('letter' or 'a4'). |
---|
| 183 | #latex_paper_size = 'letter' |
---|
| 184 | |
---|
| 185 | # The font size ('10pt', '11pt' or '12pt'). |
---|
| 186 | #latex_font_size = '10pt' |
---|
| 187 | |
---|
| 188 | # Grouping the document tree into LaTeX files. List of tuples |
---|
| 189 | # (source start file, target name, title, author, documentclass [howto/manual]). |
---|
| 190 | latex_documents = [ |
---|
[13646] | 191 | ('index', 'WAeUPKofaDocumentation.tex', u'WAeUP.Kofa Documentation', |
---|
[5331] | 192 | u'WAeUP Team', 'manual'), |
---|
| 193 | ] |
---|
| 194 | |
---|
| 195 | # The name of an image file (relative to this directory) to place at the top of |
---|
| 196 | # the title page. |
---|
| 197 | #latex_logo = None |
---|
| 198 | |
---|
| 199 | # For "manual" documents, if this is true, then toplevel headings are parts, |
---|
| 200 | # not chapters. |
---|
| 201 | #latex_use_parts = False |
---|
| 202 | |
---|
| 203 | # Additional stuff for the LaTeX preamble. |
---|
| 204 | #latex_preamble = '' |
---|
| 205 | |
---|
| 206 | # Documents to append as an appendix to all manuals. |
---|
| 207 | #latex_appendices = [] |
---|
| 208 | |
---|
| 209 | # If false, no module index is generated. |
---|
| 210 | #latex_use_modindex = True |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | # Example configuration for intersphinx: refer to the Python standard library. |
---|
| 214 | intersphinx_mapping = {'http://docs.python.org/': None} |
---|
[13469] | 215 | |
---|
| 216 | |
---|
| 217 | def autodoc_skip_dotnamed_members(app, what, name, obj, skip, optios): |
---|
| 218 | """In autodoc skip members with dot in name. |
---|
| 219 | |
---|
| 220 | Sphinx chokes when it comes to objects that have dots in their name. |
---|
| 221 | |
---|
| 222 | We will make this skipping an option of the then used |
---|
| 223 | `waeup.sphinx.autodoc` package. |
---|
| 224 | |
---|
| 225 | This is clearly a workaround and not a solution. This is a |
---|
| 226 | workaround, not a solution. |
---|
| 227 | |
---|
| 228 | In the long run our patch to Sphinx core will hopefully make it into |
---|
| 229 | the Sphinx package itself. This would be a solution, not a |
---|
| 230 | workaround. |
---|
| 231 | """ |
---|
| 232 | if "." in name: |
---|
| 233 | ## Uncomment the following line to see what is skipped. |
---|
| 234 | # print("SKIPPING %r %r %r" % (what, name, obj)) |
---|
| 235 | return True |
---|
| 236 | return False |
---|
| 237 | |
---|
| 238 | def setup(app): |
---|
| 239 | app.connect('autodoc-skip-member', autodoc_skip_dotnamed_members) |
---|