mirror of
https://github.com/facebookresearch/ReAgent.git
synced 2026-05-17 12:40:39 +00:00
Kittipat Virochsiri
492b70b749
Summary: Add a page for CI instructions Reviewed By: czxttkl Differential Revision: D17983742 fbshipit-source-id: 31479a349310a55844cea7ea97629fcd96d5b1b6
79 lines
2.3 KiB
Python
79 lines
2.3 KiB
Python
# 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 --------------------------------------------------------------
|
|
from __future__ import absolute_import, division, print_function, unicode_literals
|
|
|
|
# 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("../"))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
project = "ReAgent"
|
|
copyright = "2019, Facebook Inc."
|
|
author = "ReAgent Team"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = "1.0"
|
|
|
|
|
|
# -- 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 = [
|
|
"sphinxcontrib.apidoc",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.coverage",
|
|
"sphinxcontrib.napoleon",
|
|
]
|
|
apidoc_module_dir = "../ml"
|
|
apidoc_output_dir = "api"
|
|
apidoc_excluded_paths = ["rl/test"]
|
|
|
|
# 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 = []
|
|
|
|
autodoc_mock_imports = [
|
|
"scipy",
|
|
"numpy",
|
|
"caffe2",
|
|
"torch",
|
|
"pandas",
|
|
"sklearn",
|
|
"ml.rl.thrift",
|
|
"ml.rl.test",
|
|
"onnx",
|
|
"xgboost",
|
|
]
|
|
|
|
# -- 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 = "sphinx_rtd_theme"
|
|
|
|
# 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"]
|