conf.py 3.47 KB
 Lambert Theisen committed Jul 17, 2019 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # import os import sys sys.path.insert(0, os.path.abspath('../src'))  Lambert Theisen committed Jul 18, 2019 16 17 sys.path.insert(0, os.path.abspath('../tests/heat')) sys.path.insert(0, os.path.abspath('../tests/stress'))  Lambert Theisen committed Aug 11, 2019 18 sys.path.insert(0, os.path.abspath('../tests/r13'))  Lambert Theisen committed Sep 13, 2019 19 sys.path.insert(0, os.path.abspath('../examples'))  Lambert Theisen committed Jul 17, 2019 20 21 22 23  # -- Project information ----------------------------------------------------- project = 'fenicsR13'  Lambert Theisen committed Sep 19, 2019 24 copyright = '2019'  Lambert Theisen committed Jul 17, 2019 25 26 27 author = 'Lambert Theisen' # The full version, including alpha/beta/rc tags  Lambert Theisen committed Sep 23, 2019 28 release = '1.0'  Lambert Theisen committed Jul 17, 2019 29 30 31 32 33 34 35 36 37 38 39 40  # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.autosummary', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode',  Lambert Theisen committed Jul 29, 2019 41 42  'sphinx.ext.napoleon', # for numpy and Google docstrings 'fluiddoc.mathmacro',  Lambert Theisen committed Aug 13, 2019 43  'sphinx.ext.imgconverter', # for svg usage in latex, but bad output  Lambert Theisen committed Aug 15, 2019 44  'sphinx.ext.graphviz',  Lambert Theisen committed Jul 17, 2019 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'alabaster'  Lambert Theisen committed Aug 15, 2019 63 64 today_fmt = '%b %d %y at %H:%M' # for |today| directive in index.rst  Lambert Theisen committed Jul 17, 2019 65 66 67 68 69 # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static']  Lambert Theisen committed Jul 31, 2019 70 71 html_logo = "../media/logo_large.png" html_favicon = "../media/logo_large.png"  Lambert Theisen committed Aug 14, 2019 72   Lambert Theisen committed Jul 18, 2019 73 74 75  html_theme_options = { 'sidebar_collapse': False,  Lambert Theisen committed Jul 18, 2019 76  'description': "Release v{}
Extended gas dynamics using FEniCS platform.".format(release),  Lambert Theisen committed Jul 31, 2019 77  "touch_icon": "../media/logo_large.png",  Lambert Theisen committed Aug 12, 2019 78  "fixed_sidebar": False, # fails on mobile and with large sidebar  Lambert Theisen committed Jul 18, 2019 79 80  "note_bg": "#FFF59C", "show_relbars": False,  Lambert Theisen committed Jul 18, 2019 81 }  Lambert Theisen committed Jul 29, 2019 82   Lambert Theisen committed Aug 14, 2019 83 84 85 # -- LaTeX latex_logo = "../media/logo_large.png" latex_elements = {  Lambert Theisen committed Aug 14, 2019 86 87 88 89 90  'extraclassoptions': 'openany', # skip empty pages # 'printindex': '\\footnotesize\\raggedright\\printindex', # small index 'preamble': r''' \usepackage[columns=1]{idxlayout} ''' # for onecolumn index layout  Lambert Theisen committed Aug 14, 2019 91 }  Lambert Theisen committed Jul 29, 2019 92 93 94 95 96 97 98 99 100 101 102 103 104 105  # -- Autodoc autodoc_default_options = { 'members': True, 'member-order': 'bysource', 'undoc-members': True, 'private-members': True, 'special-members': True, # 'inherited-members': True, 'show-inheritance': True, # 'ignore-module-all': True, # 'imported-members': True, 'exclude-members': '__dict__,__module__,__weakref__' }