xref: /aosp_15_r20/external/pytorch/docs/cpp/source/Doxyfile (revision da0073e96a02ea20f0ac840b70461e3646d07c45)
1################################################################################
2# Primary project setup.                                                       #
3################################################################################
4PROJECT_NAME           = "PyTorch"
5# Parent directory of where Doxygen should output files.  Cannot be for example
6# `../build/doxygen` because if `../build` does not exist Doxygen will error.
7OUTPUT_DIRECTORY       = ../build
8# XML output stored in ${OUTPUT_DIRECTORY}/${XML_OUTPUT}.  Must agree
9# with what is specified to `breathe_projects` in `conf.py`.
10XML_OUTPUT             = xml
11# HTML output stored in ${OUTPUT_DIRECTORY}/${HTML_OUTPUT}.
12# NOTE: it can be useful to have Doxygen generate HTML to verify what sphinx is
13#       creating, or to generate HTML documentation to check a docstring you are
14#       writing without needing to wait for Sphinx.
15#
16#       # Must run from this directory (see relative paths below...)
17#       $ cd /path/to/pytorch/docs/cpp/source
18#
19#       # Send configs in this file plus `GENERATE_HTML=YES` to doxygen on stdin
20#       $ (cat Doxyfile; echo 'GENERATE_HTML = YES') | doxygen -
21#
22#       # View the doxygen results.
23#       $ open ../build/doxygen_html/index.html
24#
25#       This sends everything in this file plus `GENERATE_HTML = YES` to doxygen
26#       on stdin.  Without needing to edit this `Doxyfile` directly.
27HTML_OUTPUT            = doxygen_html
28# Strip the path prefix.  *MUST* agree with `exhale_args` in conf.py.
29# {repo_root}/docs/cpp/source/../../.. -> {repo_root}
30STRIP_FROM_PATH        = ../../..
31# What folders / files Doxygen should process.
32INPUT                  = ../../../aten/src/ATen/ATen.h \
33                         ../../../aten/src/ATen/Backend.h \
34                         ../../../aten/src/ATen/core/ivalue.h \
35                         ../../../aten/src/ATen/core/ScalarType.h \
36                         ../../../aten/src/ATen/cuda/CUDAContext.h \
37                         ../../../aten/src/ATen/cudnn/Descriptors.h \
38                         ../../../aten/src/ATen/cudnn/Handles.h \
39                         ../../../aten/src/ATen/cudnn/Types.h \
40                         ../../../aten/src/ATen/cudnn/Utils.h \
41                         ../../../aten/src/ATen/DeviceGuard.h \
42                         ../../../aten/src/ATen/Layout.h \
43                         ../../../aten/src/ATen/mkl/Descriptors.h \
44                         ../../../aten/src/ATen/Scalar.h \
45                         ../../../aten/src/ATen/TensorOptions.h \
46                         ../../../aten/src/ATen/core/Tensor.h \
47                         ../../../aten/src/ATen/native/TensorShape.h \
48                         ../../../build/aten/src/ATen/Functions.h \
49                         ../../../build/aten/src/ATen/core/TensorBody.h \
50                         ../../../c10/core/Device.h \
51                         ../../../c10/core/DeviceType.h \
52                         ../../../c10/util/Half.h \
53                         ../../../c10/util/ArrayRef.h \
54                         ../../../c10/util/OptionalArrayRef.h \
55                         ../../../c10/util/Exception.h \
56                         ../../../c10/util/Optional.h \
57                         ../../../c10/cuda/CUDAGuard.h \
58                         ../../../c10/cuda/CUDAStream.h \
59                         ../../../c10/xpu/XPUStream.h \
60                         ../../../torch/csrc/api/include \
61                         ../../../torch/csrc/api/src \
62                         ../../../torch/csrc/autograd/autograd.h \
63                         ../../../torch/csrc/autograd/custom_function.h \
64                         ../../../torch/csrc/autograd/function.h \
65                         ../../../torch/csrc/autograd/variable.h \
66                         ../../../torch/csrc/autograd/generated/variable_factories.h \
67                         ../../../torch/csrc/jit/runtime/custom_operator.h \
68                         ../../../torch/csrc/jit/serialization/import.h \
69                         ../../../torch/csrc/jit/api/module.h \
70                         ../../../torch/library.h \
71                         ../../../torch/custom_class.h
72# Don't include .cpp files!
73FILE_PATTERNS          = *.h
74# If you need this to be YES, exhale will probably break.
75CREATE_SUBDIRS         = NO
76# So that Doxygen does not trim paths, which affects the file hierarchy
77FULL_PATH_NAMES        = YES
78# Nested folders will be ignored without this.
79RECURSIVE              = YES
80# Exclude certain file patterns from the INPUT section.
81EXCLUDE = ../../../torch/csrc/api/include/torch/nn/pimpl-inl.h \
82          ../../../torch/csrc/api/include/torch/detail
83# Increase the max node size for our large files
84DOT_GRAPH_MAX_NODES    = 100
85################################################################################
86# Output formats for Doxygen to create.                                        #
87################################################################################
88# Set to YES if you are debugging or want to compare.
89GENERATE_HTML          = NO
90# Unless you want it...
91GENERATE_LATEX         = NO
92# Both breathe and exhale need the xml.
93GENERATE_XML           = YES
94# Set to NO if you do not want the Doxygen program listing included.
95# NOTE: setting to NO may result in unrecovered file relationships
96#       (which file defined which compound)
97XML_PROGRAMLISTING     = YES
98################################################################################
99# Doxygen preprocessor / parser control.                                       #
100################################################################################
101ENABLE_PREPROCESSING   = YES
102MACRO_EXPANSION        = YES
103EXPAND_ONLY_PREDEF     = NO
104SKIP_FUNCTION_MACROS   = NO
105# Extra defs for to help with building the _right_ version of the docs
106PREDEFINED             = DOXYGEN_DOCUMENTATION_BUILD
107PREDEFINED            += DOXYGEN_SHOULD_SKIP_THIS
108# Symbol expansion to follow for #include statements (not input)
109SEARCH_INCLUDES        = YES
110INCLUDE_PATH           = ../../.. \
111                         ../../../torch/csrc/api/include \
112                         ../../../build/aten/src
113################################################################################
114# Compound extraction control.                                                 #
115################################################################################
116EXTRACT_ALL            = YES
117EXTRACT_PACKAGE        = YES
118EXTRACT_STATIC         = YES
119CASE_SENSE_NAMES       = NO
120EXCLUDE_SYMBOLS        = caffe2::* cereal* DL* TH* cudnn* std::*
121# EXCLUDE_SYMBOLS        = c10::* caffe2::* cereal* DL* TH* cudnn* std::*
122################################################################################
123# Docstring control / customization.                                           #
124################################################################################
125# First line of /** comment */ treated as \brief
126JAVADOC_AUTOBRIEF      = YES
127# Allow for rst directives and advanced functions e.g. grid tables
128# Example:
129#     /**
130#      * \rst
131#      * .. code-block:: cpp
132#      *
133#      *     int main() {
134#      *         return 0;
135#      *     }
136#      *
137#      * \endrst
138#      */
139# NOTE:
140#     1. \rst and \endrst must be on their own line.
141#     2. leading-asterisk required.
142ALIASES                = "rst=\verbatim embed:rst:leading-asterisk"
143ALIASES               += "endrst=\endverbatim"
144################################################################################
145# Warning suppression.                                                         #
146################################################################################
147QUIET                  = YES
148WARN_IF_UNDOCUMENTED   = NO
149