|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# Feast documentation build configuration file, created by |
| 4 | +# sphinx-quickstart on Sat Nov 30 15:06:53 2019. |
| 5 | +# |
| 6 | +# This file is execfile()d with the current directory set to its |
| 7 | +# containing dir. |
| 8 | +# |
| 9 | +# Note that not all possible configuration values are present in this |
| 10 | +# autogenerated file. |
| 11 | +# |
| 12 | +# All configuration values have a default; values that are commented out |
| 13 | +# serve to show the default. |
| 14 | + |
| 15 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 16 | +# add these directories to sys.path here. If the directory is relative to the |
| 17 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 18 | +# |
| 19 | +import os |
| 20 | +import sys |
| 21 | + |
| 22 | +import sphinx_rtd_theme |
| 23 | + |
| 24 | +sys.path.insert(0, os.path.abspath("../../feast")) |
| 25 | +sys.path.insert(0, os.path.abspath("../..")) |
| 26 | + |
| 27 | + |
| 28 | +# -- Build protos --------------------------------------------------------- |
| 29 | + |
| 30 | +# For an unknown reason, the Python protos stopped being built correctly. |
| 31 | +# See https://readthedocs.org/projects/feast/builds/17686555/ for an |
| 32 | +# example where the Python protos did not build, which subsequently broke |
| 33 | +# the RTD build. In order to fix this, we manually compile the protos. |
| 34 | +import subprocess |
| 35 | + |
| 36 | +from pathlib import Path |
| 37 | + |
| 38 | +# cwd will be feast/sdk/python/docs/source |
| 39 | +cwd = Path(os.getcwd()) |
| 40 | + |
| 41 | +# Change to feast/ |
| 42 | +os.chdir(cwd.parent.parent.parent.parent) |
| 43 | + |
| 44 | +# Compile Python protos |
| 45 | +result = subprocess.run(["python", "setup.py", "build_python_protos", "--inplace"], capture_output=True) |
| 46 | +stdout = result.stdout.decode("utf-8") |
| 47 | +stderr = result.stderr.decode("utf-8") |
| 48 | +print(f"Apply stdout:\n{stdout}") |
| 49 | +print(f"Apply stderr:\n{stderr}") |
| 50 | + |
| 51 | +# -- General configuration ------------------------------------------------ |
| 52 | + |
| 53 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 54 | +# |
| 55 | +# needs_sphinx = '1.0' |
| 56 | + |
| 57 | +# Add any Sphinx extension module names here, as strings. They can be |
| 58 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 59 | +# ones. |
| 60 | +extensions = [ |
| 61 | + "sphinx.ext.doctest", |
| 62 | + "sphinx.ext.intersphinx", |
| 63 | + "sphinx.ext.todo", |
| 64 | + "sphinx.ext.coverage", |
| 65 | + "sphinx.ext.mathjax", |
| 66 | + "sphinx.ext.ifconfig", |
| 67 | + "sphinx.ext.viewcode", |
| 68 | + "sphinx.ext.githubpages", |
| 69 | + "sphinx.ext.napoleon", |
| 70 | + "sphinx.ext.autodoc", |
| 71 | + "sphinx_rtd_theme", |
| 72 | +] |
| 73 | + |
| 74 | +# Add any paths that contain templates here, relative to this directory. |
| 75 | +templates_path = ["_templates"] |
| 76 | + |
| 77 | +# The suffix(es) of source filenames. |
| 78 | +# You can specify multiple suffix as a list of string: |
| 79 | +# |
| 80 | +# source_suffix = ['.rst', '.md'] |
| 81 | +source_suffix = ".rst" |
| 82 | + |
| 83 | +# The master toctree document. |
| 84 | +master_doc = "index" |
| 85 | + |
| 86 | +# General information about the project. |
| 87 | +project = "Feast" |
| 88 | +copyright = "2021, Feast Authors" |
| 89 | +author = "Feast Authors" |
| 90 | + |
| 91 | +# The version info for the project you're documenting, acts as replacement for |
| 92 | +# |version| and |release|, also used in various other places throughout the |
| 93 | +# built documents. |
| 94 | +# |
| 95 | +# The short X.Y version. |
| 96 | + |
| 97 | +# TODO: Add the below versions back to documentation building. |
| 98 | +# version = ( |
| 99 | +# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip() |
| 100 | +# ) |
| 101 | +# The full version, including alpha/beta/rc tags. |
| 102 | +# release = ( |
| 103 | +# os.popen("git describe --tags $(git rev-list --tags --max-count=1)").read().strip() |
| 104 | +# ) |
| 105 | + |
| 106 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 107 | +# for a list of supported languages. |
| 108 | +# |
| 109 | +# This is also used if you do content translation via gettext catalogs. |
| 110 | +# Usually you set "language" from the command line for these cases. |
| 111 | +language = None |
| 112 | + |
| 113 | +# List of patterns, relative to source directory, that match files and |
| 114 | +# directories to ignore when looking for source files. |
| 115 | +# This patterns also effect to html_static_path and html_extra_path |
| 116 | +exclude_patterns = [] |
| 117 | + |
| 118 | +# The name of the Pygments (syntax highlighting) style to use. |
| 119 | +pygments_style = "sphinx" |
| 120 | + |
| 121 | +# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 122 | +todo_include_todos = True |
| 123 | + |
| 124 | + |
| 125 | +# -- Options for HTML output ---------------------------------------------- |
| 126 | + |
| 127 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 128 | +# a list of builtin themes. |
| 129 | +# |
| 130 | +html_theme = "sphinx_rtd_theme" |
| 131 | + |
| 132 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 133 | +# further. For a list of options available for each theme, see the |
| 134 | +# documentation. |
| 135 | +# |
| 136 | +html_theme_options = {} |
| 137 | + |
| 138 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 139 | +# relative to this directory. They are copied after the builtin static files, |
| 140 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 141 | +html_static_path = ["_static"] |
| 142 | + |
| 143 | + |
| 144 | +# -- Options for HTMLHelp output ------------------------------------------ |
| 145 | + |
| 146 | +# Output file base name for HTML help builder. |
| 147 | +htmlhelp_basename = "Feastdoc" |
| 148 | + |
| 149 | + |
| 150 | +# -- Options for LaTeX output --------------------------------------------- |
| 151 | + |
| 152 | +latex_elements = { |
| 153 | + # The paper size ('letterpaper' or 'a4paper'). |
| 154 | + # |
| 155 | + # 'papersize': 'letterpaper', |
| 156 | + # The font size ('10pt', '11pt' or '12pt'). |
| 157 | + # |
| 158 | + # 'pointsize': '10pt', |
| 159 | + # Additional stuff for the LaTeX preamble. |
| 160 | + # |
| 161 | + # 'preamble': '', |
| 162 | + # Latex figure (float) alignment |
| 163 | + # |
| 164 | + # 'figure_align': 'htbp', |
| 165 | +} |
| 166 | + |
| 167 | +# Grouping the document tree into LaTeX files. List of tuples |
| 168 | +# (source start file, target name, title, |
| 169 | +# author, documentclass [howto, manual, or own class]). |
| 170 | +latex_documents = [ |
| 171 | + (master_doc, "Feast.tex", "Feast Documentation", "Feast Authors", "manual") |
| 172 | +] |
| 173 | + |
| 174 | + |
| 175 | +# -- Options for manual page output --------------------------------------- |
| 176 | + |
| 177 | +# One entry per manual page. List of tuples |
| 178 | +# (source start file, name, description, authors, manual section). |
| 179 | +man_pages = [(master_doc, "feast", "Feast Documentation", [author], 1)] |
| 180 | + |
| 181 | + |
| 182 | +# -- Options for Texinfo output ------------------------------------------- |
| 183 | + |
| 184 | +# Grouping the document tree into Texinfo files. List of tuples |
| 185 | +# (source start file, target name, title, author, |
| 186 | +# dir menu entry, description, category) |
| 187 | +texinfo_documents = [ |
| 188 | + ( |
| 189 | + master_doc, |
| 190 | + "Feast", |
| 191 | + "Feast Documentation", |
| 192 | + author, |
| 193 | + "Feast", |
| 194 | + "One line description of project.", |
| 195 | + "Miscellaneous", |
| 196 | + ) |
| 197 | +] |
| 198 | + |
| 199 | + |
| 200 | +# Example configuration for intersphinx: refer to the Python standard library. |
| 201 | +intersphinx_mapping = {"https://docs.python.org/": None} |
0 commit comments