[docs] add docs for APIs (#72)

facebookresearch · Sep 9, 2020 · fad970a · fad970a
1 parent 4f59723
commit fad970a
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 12 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,4 @@ sphinx==3.2.1
 sphinx_rtd_theme==0.4.3
 sphinxcontrib-programoutput==0.16
 -e git+https://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
+torch=1.6.0
diff --git a/docs/source/api/nn/pipe.rst b/docs/source/api/nn/pipe.rst
@@ -0,0 +1,4 @@
+Pipe
+====
+
+.. autoclass:: fairscale.nn.Pipe
diff --git a/docs/source/api/optim/oss.rst b/docs/source/api/optim/oss.rst
@@ -0,0 +1,4 @@
+OSS
+====
+
+.. autoclass:: fairscale.optim.OSS
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -10,19 +10,19 @@
 # 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 sys
 
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information -----------------------------------------------------
 
-project = 'fairscale'
-copyright = '2020, Facebook AI Research'
-author = 'Facebook AI Research'
+project = "fairscale"
+copyright = "2020, Facebook AI Research"
+author = "Facebook AI Research"
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.2'
+release = "0.0.2"
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,10 +31,11 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "sphinx.ext.autodoc",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -47,9 +48,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # 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']
+html_static_path = ["_static"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,9 +7,11 @@ Welcome to fairscale's documentation!
 =====================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
+   :caption: API Reference
 
+   api/optim/oss
+   api/nn/pipe
 
 
 Indices and tables