|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +# |
| 4 | +# libmk documentation build configuration file, created by |
| 5 | +# sphinx-quickstart on Wed Feb 27 11:02:22 2019. |
| 6 | +# |
| 7 | + |
| 8 | +import subprocess |
| 9 | +import os |
| 10 | +import sys |
| 11 | + |
| 12 | +rtd_build = os.environ.get('READTHEDOCS', None) == 'True' |
| 13 | +if rtd_build: |
| 14 | + subprocess.call("doxygen doxygen.conf", shell=True) |
| 15 | + |
| 16 | + |
| 17 | +os.chdir(".." if rtd_build else "../..") |
| 18 | +print("Building documentation from:", os.getcwd()) |
| 19 | +sys.path.append(os.getcwd()) |
| 20 | + |
| 21 | + |
| 22 | +# -- General configuration ------------------------------------------------ |
| 23 | + |
| 24 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 25 | +# |
| 26 | +# needs_sphinx = "1.0" |
| 27 | + |
| 28 | +# Add any Sphinx extension module names here, as strings. They can be |
| 29 | +# extensions coming with Sphinx (named "sphinx.ext.*") or your custom |
| 30 | +# ones. |
| 31 | +extensions = [ |
| 32 | + "sphinx.ext.autodoc", |
| 33 | + "sphinx.ext.autosummary", |
| 34 | + "sphinx.ext.viewcode", |
| 35 | + "breathe"] |
| 36 | + |
| 37 | +# Add any paths that contain templates here, relative to this directory. |
| 38 | +templates_path = ["_templates"] |
| 39 | + |
| 40 | +# The suffix(es) of source filenames. |
| 41 | +# You can specify multiple suffix as a list of string: |
| 42 | +# |
| 43 | +# source_suffix = [".rst", ".md"] |
| 44 | +source_suffix = ".rst" |
| 45 | + |
| 46 | +# The master toctree document. |
| 47 | +master_doc = "index" |
| 48 | + |
| 49 | +# General information about the project. |
| 50 | +project = "libmk" |
| 51 | +copyright = "2019, RedFantom" |
| 52 | +author = "RedFantom" |
| 53 | + |
| 54 | +# The version info for the project you"re documenting, acts as replacement for |
| 55 | +# |version| and |release|, also used in various other places throughout the |
| 56 | +# built documents. |
| 57 | +# |
| 58 | +# The short X.Y version. |
| 59 | +version = "0.1.1" |
| 60 | +# The full version, including alpha/beta/rc tags. |
| 61 | +release = "0.1.1" |
| 62 | + |
| 63 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 64 | +# for a list of supported languages. |
| 65 | +# |
| 66 | +# This is also used if you do content translation via gettext catalogs. |
| 67 | +# Usually you set "language" from the command line for these cases. |
| 68 | +language = None |
| 69 | + |
| 70 | +# List of patterns, relative to source directory, that match files and |
| 71 | +# directories to ignore when looking for source files. |
| 72 | +# This patterns also effect to html_static_path and html_extra_path |
| 73 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
| 74 | + |
| 75 | +# The name of the Pygments (syntax highlighting) style to use. |
| 76 | +pygments_style = "sphinx" |
| 77 | + |
| 78 | +# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 79 | +todo_include_todos = True |
| 80 | + |
| 81 | +# -- Options for HTML output ---------------------------------------------- |
| 82 | + |
| 83 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 84 | +# a list of builtin themes. |
| 85 | +# |
| 86 | +html_theme = "sphinx_rtd_theme" |
| 87 | +html_theme_path = [""] |
| 88 | + |
| 89 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 90 | +# further. For a list of options available for each theme, see the |
| 91 | +# documentation. |
| 92 | +# |
| 93 | +# html_theme_options = {} |
| 94 | + |
| 95 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 96 | +# relative to this directory. They are copied after the builtin static files, |
| 97 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 98 | +html_static_path = ["_static"] |
| 99 | + |
| 100 | +# Custom sidebar templates, must be a dictionary that maps document names |
| 101 | +# to template names. |
| 102 | +# |
| 103 | +# This is required for the alabaster theme |
| 104 | +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars |
| 105 | +html_sidebars = { |
| 106 | + "**": [ |
| 107 | + "relations.html", # needs "show_related": True theme option to display |
| 108 | + "searchbox.html", |
| 109 | + ] |
| 110 | +} |
| 111 | + |
| 112 | +# -- Options for manual page output --------------------------------------- |
| 113 | + |
| 114 | +# One entry per manual page. List of tuples |
| 115 | +# (source start file, name, description, authors, manual section). |
| 116 | +man_pages = [ |
| 117 | + (master_doc, "libmk", "libmk Documentation", |
| 118 | + [author], 1) |
| 119 | +] |
| 120 | + |
| 121 | +# -- Options for Breathe Extension ---------------------------------------- |
| 122 | +breathe_projects = { |
| 123 | + "libmk": "../doxygen/xml" if not rtd_build else "doxygen/xml" |
| 124 | +} |
| 125 | +breathe_default_project = "libmk" |
0 commit comments