conf.py (3513B)
1 # Configuration file for the Sphinx documentation builder. 2 # 3 # This file only contains a selection of the most common options. For a full 4 # list see the documentation: 5 # https://www.sphinx-doc.org/en/master/usage/configuration.html 6 7 # -- Path setup -------------------------------------------------------------- 8 9 # If extensions (or modules to document with autodoc) are in another directory, 10 # add these directories to sys.path here. If the directory is relative to the 11 # documentation root, use os.path.abspath to make it absolute, like shown here. 12 # 13 # import os 14 # import sys 15 # sys.path.insert(0, os.path.abspath('.')) 16 17 18 # -- Project information ----------------------------------------------------- 19 20 project = 'Jami' 21 copyright = '2021, SFL Employees and Contributors' 22 author = 'SFL Employees and Contributors' 23 24 # -- General configuration --------------------------------------------------- 25 26 # Add any Sphinx extension module names here, as strings. They can be 27 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 28 # ones. 29 extensions = ['recommonmark', 30 # Convert SVG images when doing a latex build 31 'sphinx.ext.imgconverter', 32 # Auto-generate section labels (for linking between documents in a portable way) 33 'sphinx.ext.autosectionlabel', 34 ] 35 36 source_suffix = { 37 '.rst': 'restructuredtext', 38 '.txt': 'restructuredtext', 39 '.md': 'markdown', 40 } 41 42 # ignore warnings about duplicate links; often we want to link to something multiple times in a doc (e.g. the FAQ) 43 suppress_warnings = ['autosectionlabel.*'] 44 45 # link to the "Swarms" heading in the Technical Overview document like this: technical-overview#swarms (or markdown: technical-overview:swarms) 46 autosectionlabel_prefix_document = True 47 48 # 49 autosectionlabel_maxdepth = 4 50 51 52 # Add any paths that contain templates here, relative to this directory. 53 templates_path = ['_templates'] 54 55 # List of patterns, relative to source directory, that match files and 56 # directories to ignore when looking for source files. 57 # This pattern also affects html_static_path and html_extra_path. 58 exclude_patterns = [] 59 60 61 # -- Options for HTML output ------------------------------------------------- 62 63 # The theme to use for HTML and HTML Help pages. See the documentation for 64 # a list of builtin themes. 65 # 66 html_theme = 'sphinx_rtd_theme' 67 68 html_theme_options = { 69 'navigation_depth': 3, 70 'sticky_navigation': False, 71 'collapse_navigation': False, 72 } 73 74 html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] } 75 76 # html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] } 77 78 # Add any paths that contain custom static files (such as style sheets) here, 79 # relative to this directory. They are copied after the builtin static files, 80 # so a file named "default.css" will overwrite the builtin "default.css". 81 html_static_path = ['_static'] 82 83 # -- Options for LaTeX pdf output --------------------------------------------- 84 85 latex_engine = 'xelatex' 86 latex_elements = { 87 # The paper size ('letterpaper' or 'a4paper'). 88 'papersize': 'a4paper', 89 # The font size ('10pt', '11pt' or '12pt'). 90 'pointsize': '10pt', 91 92 'fontpkg': r''' 93 \setmainfont{Linux Libertine} 94 ''', 95 'preamble': r''' 96 \setcounter{tocdepth}{2} 97 98 ''', 99 'fncychap': r'\usepackage[Rejne]{fncychap}', 100 'sphinxsetup': \ 101 'hmargin={0.7in,0.7in}, vmargin={1in,1in}, \ 102 verbatimwithframe=false,' 103 } 104 latex_show_urls = 'footnote'