9bddf7044d
Summary: Formats the covered files with pyfmt. ruff_dog Reviewed By: d16r Differential Revision: D65988249 fbshipit-source-id: 0f7744962428982d0343cc76a7520b4f54e9676a
91 lines
2.8 KiB
Python
91 lines
2.8 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the BSD-style license found in the
|
|
# LICENSE file in the root directory of this source tree.
|
|
|
|
# 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('.'))
|
|
|
|
import os
|
|
import subprocess
|
|
|
|
|
|
def configureDoxyfile(input_dir, output_dir):
|
|
with open("Doxyfile.in", "r") as file:
|
|
filedata = file.read()
|
|
|
|
filedata = filedata.replace("@DOXYGEN_INPUT_DIR@", input_dir)
|
|
filedata = filedata.replace("@DOXYGEN_OUTPUT_DIR@", output_dir)
|
|
|
|
with open("Doxyfile", "w") as file:
|
|
file.write(filedata)
|
|
|
|
|
|
# Check if we're running on Read the Docs' servers
|
|
read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True"
|
|
|
|
breathe_projects = {}
|
|
if read_the_docs_build:
|
|
input_dir = "../include/fbgemm"
|
|
output_dir = "build"
|
|
configureDoxyfile(input_dir, output_dir)
|
|
subprocess.call("doxygen", shell=True)
|
|
breathe_projects["fbgemm"] = output_dir + "/xml"
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "FBGEMM"
|
|
copyright = "2020, Facebook Inc."
|
|
author = "Facebook Inc."
|
|
|
|
|
|
# -- 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 = ["breathe"]
|
|
|
|
# ...
|
|
|
|
# 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 = "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"]
|
|
|
|
# Breathe Configuration
|
|
breathe_default_project = "FBGEMM"
|