add cpp api reference

Differential Revision: D49924199

Author: JacobSzwejbka

docs/source/conf.py

@@ -44,6 +44,8 @@
 sys.path.insert(0, os.path.abspath("../../"))
 
 extensions = [
+    "breathe",
+    "exhale",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.autosummary",
@@ -61,6 +63,59 @@
     "executorch_custom_versions",
 ]
 
+# Setup absolute paths for communicating with breathe / exhale where
+# items are expected / should be trimmed by.
+# This file is {repo_root}/docs/cpp/source/conf.py
+this_file_dir = os.path.abspath(os.path.dirname(__file__))
+doxygen_xml_dir = os.path.abspath("../website/sphinxbuild_cpp/xml")
+repo_root = os.path.dirname(  # {repo_root}
+    os.path.dirname(  # {repo_root}/docs
+        os.path.dirname(  # {repo_root}/docs/cpp
+            this_file_dir  # {repo_root}/docs/cpp/source
+        )
+    )
+)
+
+breathe_projects = {"PyTorch": doxygen_xml_dir}
+breathe_default_project = "PyTorch"
+
+# Setup the exhale extension
+exhale_args = {
+    ############################################################################
+    # These arguments are required.                                            #
+    ############################################################################
+    "containmentFolder": "./cpp_api",
+    "rootFileName": "library_root.rst",
+    "rootFileTitle": "Library API",
+    "doxygenStripFromPath": repo_root,
+    ############################################################################
+    # Suggested optional arguments.                                            #
+    ############################################################################
+    "createTreeView": True,
+    "exhaleExecutesDoxygen": True,
+    "exhaleUseDoxyfile": True,
+    "verboseBuild": True,
+    ############################################################################
+    # HTML Theme specific configurations.                                      #
+    ############################################################################
+    # Fix broken Sphinx RTD Theme 'Edit on GitHub' links
+    # Search for 'Edit on GitHub' on the FAQ:
+    #     http://exhale.readthedocs.io/en/latest/faq.html
+    "pageLevelConfigMeta": ":github_url: https://github.com/pytorch/pytorch",
+    ############################################################################
+    # Individual page layout example configuration.                            #
+    ############################################################################
+    # Example of adding contents directives on custom kinds with custom title
+    "contentsTitle": "Page Contents",
+    "kindsWithContentsDirectives": ["class", "file", "namespace", "struct"],
+    # Exclude PIMPL files from class hierarchy tree and namespace pages.
+    "listingExclude": [r".*Impl$"],
+    ############################################################################
+    # Main library page layout example configuration.                          #
+    ############################################################################
+    "afterTitleDescription": "Welcome to the ExecuTorch's documentation.",
+}
+
 templates_path = ["_templates"]
 
 

docs/source/executorch-runtime-api-reference.rst

@@ -0,0 +1,40 @@
+ExecuTorch Runtime API Reference
+================================
+
+The ExecuTorch C++ API provides an on-device execution framework for exported PyTorch models.
+
+For a tutorial style introduction to the runtime API, check out the
+<TODO Insert Tutorial Link Here When It Exists> tutorial.
+
+Model Loading and Execution
+---------------------------
+
+.. doxygenclass:: torch::executor::DataLoader
+  :members:
+
+.. doxygenclass:: torch::executor::MemoryAllocator
+  :members:
+
+.. doxygenclass:: torch::executor::HierarchicalAllocator
+  :members:
+
+.. doxygenclass:: torch::executor::MemoryManager
+  :members:
+
+.. doxygenclass:: torch::executor::Program
+  :members:
+
+.. doxygenclass:: torch::executor::Method
+  :members:
+
+.. doxygenclass:: torch::executor::MethodMeta
+  :members:
+
+Values
+------
+
+.. doxygenclass:: torch::executor::EValue
+  :members:
+
+.. doxygenclass:: torch::executor::Tensor
+  :members:

docs/source/index.rst

@@ -100,6 +100,7 @@ Topics in this section will help you get started with ExecuTorch.
    :hidden:
 
    export-to-executorch-api-reference
+   executorch-runtime-api-reference
 
 .. toctree::
    :glob: