Generate C++ docs from pytorch/pytorch@54aca57

pytorch · Dec 7, 2023 · 15e1f0b · 15e1f0b
1 parent ae38453
commit 15e1f0b
Show file tree

Hide file tree

Showing 9,010 changed files with 407,493 additions and 209,881 deletions.
diff --git a/_sources/api/class_view_hierarchy.rst.txt b/_sources/api/class_view_hierarchy.rst.txt
diff --git a/_sources/api/classc10_1_1_dist_backend_error.rst.txt b/_sources/api/classc10_1_1_dist_backend_error.rst.txt
@@ -19,7 +19,7 @@ Inheritance Relationships
 Base Type
 *********
 
-- ``public c10::Error`` (:ref:`exhale_class_classc10_1_1_error`)
+- ``public c10::DistError`` (:ref:`exhale_class_classc10_1_1_dist_error`)
 
 
 Class Documentation

diff --git a/_sources/api/classc10_1_1_dist_error.rst.txt b/_sources/api/classc10_1_1_dist_error.rst.txt
@@ -0,0 +1,40 @@
+:github_url: https://github.com/pytorch/pytorch
+
+.. _exhale_class_classc10_1_1_dist_error:
+
+Class DistError
+===============
+
+- Defined in :ref:`file_c10_util_Exception.h`
+
+
+.. contents:: Page Contents
+   :local:
+   :backlinks: none
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public c10::Error`` (:ref:`exhale_class_classc10_1_1_error`)
+
+
+Derived Types
+*************
+
+- ``public c10::DistBackendError`` (:ref:`exhale_class_classc10_1_1_dist_backend_error`)
+- ``public c10::DistNetworkError`` (:ref:`exhale_class_classc10_1_1_dist_network_error`)
+- ``public c10::DistStoreError`` (:ref:`exhale_class_classc10_1_1_dist_store_error`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: c10::DistError
+   :members:
+   :protected-members:
+   :undoc-members:
diff --git a/_sources/api/classc10_1_1_dist_network_error.rst.txt b/_sources/api/classc10_1_1_dist_network_error.rst.txt
@@ -0,0 +1,32 @@
+:github_url: https://github.com/pytorch/pytorch
+
+.. _exhale_class_classc10_1_1_dist_network_error:
+
+Class DistNetworkError
+======================
+
+- Defined in :ref:`file_c10_util_Exception.h`
+
+
+.. contents:: Page Contents
+   :local:
+   :backlinks: none
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public c10::DistError`` (:ref:`exhale_class_classc10_1_1_dist_error`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: c10::DistNetworkError
+   :members:
+   :protected-members:
+   :undoc-members:
diff --git a/_sources/api/classc10_1_1_dist_store_error.rst.txt b/_sources/api/classc10_1_1_dist_store_error.rst.txt
@@ -0,0 +1,32 @@
+:github_url: https://github.com/pytorch/pytorch
+
+.. _exhale_class_classc10_1_1_dist_store_error:
+
+Class DistStoreError
+====================
+
+- Defined in :ref:`file_c10_util_Exception.h`
+
+
+.. contents:: Page Contents
+   :local:
+   :backlinks: none
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public c10::DistError`` (:ref:`exhale_class_classc10_1_1_dist_error`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: c10::DistStoreError
+   :members:
+   :protected-members:
+   :undoc-members:
diff --git a/_sources/api/classc10_1_1_error.rst.txt b/_sources/api/classc10_1_1_error.rst.txt
@@ -25,8 +25,9 @@ Base Type
 Derived Types
 *************
 
-- ``public c10::DistBackendError`` (:ref:`exhale_class_classc10_1_1_dist_backend_error`)
+- ``public c10::DistError`` (:ref:`exhale_class_classc10_1_1_dist_error`)
 - ``public c10::EnforceFiniteError`` (:ref:`exhale_class_classc10_1_1_enforce_finite_error`)
+- ``public c10::ErrorAlwaysShowCppStacktrace`` (:ref:`exhale_class_classc10_1_1_error_always_show_cpp_stacktrace`)
 - ``public c10::IndexError`` (:ref:`exhale_class_classc10_1_1_index_error`)
 - ``public c10::LinAlgError`` (:ref:`exhale_class_classc10_1_1_lin_alg_error`)
 - ``public c10::NotImplementedError`` (:ref:`exhale_class_classc10_1_1_not_implemented_error`)

diff --git a/_sources/api/classc10_1_1_error_always_show_cpp_stacktrace.rst.txt b/_sources/api/classc10_1_1_error_always_show_cpp_stacktrace.rst.txt
@@ -0,0 +1,32 @@
+:github_url: https://github.com/pytorch/pytorch
+
+.. _exhale_class_classc10_1_1_error_always_show_cpp_stacktrace:
+
+Class ErrorAlwaysShowCppStacktrace
+==================================
+
+- Defined in :ref:`file_c10_util_Exception.h`
+
+
+.. contents:: Page Contents
+   :local:
+   :backlinks: none
+
+
+Inheritance Relationships
+-------------------------
+
+Base Type
+*********
+
+- ``public c10::Error`` (:ref:`exhale_class_classc10_1_1_error`)
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: c10::ErrorAlwaysShowCppStacktrace
+   :members:
+   :protected-members:
+   :undoc-members:
diff --git a/_sources/api/classc10_1_1arrayref__optional__base.rst.txt b/_sources/api/classc10_1_1arrayref__optional__base.rst.txt
diff --git a/_sources/api/classc10_1_1bad__optional__access.rst.txt b/_sources/api/classc10_1_1bad__optional__access.rst.txt
diff --git a/_sources/api/classc10_1_1optional.rst.txt b/_sources/api/classc10_1_1optional.rst.txt
diff --git a/_sources/api/classc10_1_1optional_3_01_t_01_6_01_4.rst.txt b/_sources/api/classc10_1_1optional_3_01_t_01_6_01_4.rst.txt
diff --git a/_sources/api/classc10_1_1optional_3_01_t_01_6_6_01_4.rst.txt b/_sources/api/classc10_1_1optional_3_01_t_01_6_6_01_4.rst.txt
diff --git a/_sources/api/define__exception_8h_1a1f8348f2c9f1237f901a632d394270f4.rst.txt b/_sources/api/define__exception_8h_1a1f8348f2c9f1237f901a632d394270f4.rst.txt
@@ -0,0 +1,15 @@
+:github_url: https://github.com/pytorch/pytorch
+
+.. _exhale_define__exception_8h_1a1f8348f2c9f1237f901a632d394270f4:
+
+Define C10_BUILD_ERROR
+======================
+
+- Defined in :ref:`file_c10_util_Exception.h`
+
+
+Define Documentation
+--------------------
+
+
+.. doxygendefine:: C10_BUILD_ERROR
diff --git a/_sources/api/define__exception_8h_1a80f0e323a0aa756fc574f791358ef553.rst.txt b/_sources/api/define__exception_8h_1a80f0e323a0aa756fc574f791358ef553.rst.txt
@@ -0,0 +1,15 @@
+:github_url: https://github.com/pytorch/pytorch
+
+.. _exhale_define__exception_8h_1a80f0e323a0aa756fc574f791358ef553:
+
+Define TORCH_CHECK_ALWAYS_SHOW_CPP_STACKTRACE
+=============================================
+
+- Defined in :ref:`file_c10_util_Exception.h`
+
+
+Define Documentation
+--------------------
+
+
+.. doxygendefine:: TORCH_CHECK_ALWAYS_SHOW_CPP_STACKTRACE
diff --git a/_sources/api/define__optional_8h_1a2bc77cf029dcdedaf87668a8da6e899b.rst.txt b/_sources/api/define__optional_8h_1a2bc77cf029dcdedaf87668a8da6e899b.rst.txt
diff --git a/_sources/api/define__optional_8h_1a8df785cb8c5588e7ac8b1cf377f419c5.rst.txt b/_sources/api/define__optional_8h_1a8df785cb8c5588e7ac8b1cf377f419c5.rst.txt
diff --git a/_sources/api/define__optional_8h_1aba246528349d07cba40ef2d678e6fc78.rst.txt b/_sources/api/define__optional_8h_1aba246528349d07cba40ef2d678e6fc78.rst.txt