Hide placeholders in docs (pytorch#195)

* Hide placeholders in docs * yolo * yolo * yolo * Update docs/Makefile --------- Co-authored-by: Svetlana Karslioglu <[email protected]>
dbyoung18 · May 1, 2024 · 8ec0538 · 8ec0538
1 parent 375b6d6
commit 8ec0538
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 60 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,7 +6,12 @@ ifneq ($(EXAMPLES_PATTERN),)
 endif
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -W -j auto $(EXAMPLES_PATTERN_OPTS)
+
+# TODO: Revert this when have docs on pytorch.org/ao
+# SPHINXOPTS    = -W -j auto $(EXAMPLES_PATTERN_OPTS)
+# SPHINXOPTS    = -WT -j auto --keep-going # enable later when the files are included in the doc build 
+
+
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = torchao
 SOURCEDIR     = source

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -58,6 +58,12 @@
     "remove_config_comments": True,
 }
 
+### TODO: Delete this when we have content
+suppress_warnings = [
+    'toc.unlisted',
+]
+###
+
 napoleon_use_ivar = True
 napoleon_numpy_docstring = False
 napoleon_google_docstring = True

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -2,96 +2,99 @@ Welcome to the torchao Documentation
 =======================================
 
 **torchao** is an open-source library that provides the functionality
-to quantize and prune your models using native PyTorch.
+to quantize and prune your models using native PyTorch. Our documentation is under development
+with more content coming soon.
 
-.. grid:: 3
+..
+   .. grid:: 3
 
-     .. grid-item-card:: :octicon:`file-code;1em`
-        Getting Started
-        :img-top: _static/img/card-background.svg
-        :link: getting-started.html
-        :link-type: url
+      .. grid-item-card:: :octicon:`file-code;1em`
+         Getting Started
+         :img-top: _static/img/card-background.svg
+         :link: getting-started.html
+         :link-type: url
 
-        Learn about how to get started with torchao
-        and ts application in your projects.
+         Learn about how to get started with torchao
+         and ts application in your projects.
 
-     .. grid-item-card:: :octicon:`file-code;1em`
-        Concepts
-        :img-top: _static/img/card-background.svg
-        :link: dtypes.html
-        :link-type: url
+      .. grid-item-card:: :octicon:`file-code;1em`
+         Concepts
+         :img-top: _static/img/card-background.svg
+         :link: dtypes.html
+         :link-type: url
 
-        Learn about the key torchao concepts such
-        as dtypes, quantization, sparsity, among others.
+         Learn about the key torchao concepts such
+         as dtypes, quantization, sparsity, among others.
 
-     .. grid-item-card:: :octicon:`file-code;1em`
-        API Reference
-        :img-top: _static/img/card-background.svg
-        :link: api_ref_intro.html
-        :link-type: url
+      .. grid-item-card:: :octicon:`file-code;1em`
+         API Reference
+         :img-top: _static/img/card-background.svg
+         :link: api_ref_intro.html
+         :link-type: url
 
-        A comprehensive reference for the torchao
-        API and its functionalities.
+         A comprehensive reference for the torchao
+         API and its functionalities.
 
-Tutorials
-~~~~~~~~~
+   Tutorials
+   ~~~~~~~~~
 
-Ready to experiment? Check out some of the
-torchao tutorials.
+   Ready to experiment? Check out some of the
+   torchao tutorials.
 
-.. customcardstart::
+   .. customcardstart::
 
-.. customcarditem::
-   :header: Template Tutorial
-   :card_description: A placeholder template for demo purposes
-   :image: _static/img/generic-pytorch-logo.png
-   :link: tutorials/template_tutorial.html
-   :tags: template
+   .. customcarditem::
+      :header: Template Tutorial
+      :card_description: A placeholder template for demo purposes
+      :image: _static/img/generic-pytorch-logo.png
+      :link: tutorials/template_tutorial.html
+      :tags: template
 
-.. customcardend::
+   .. customcardend::
 
 
 .. ----------------------------------------------------------------------
 .. Below is the toctree i.e. it defines the content of the left sidebar.
 .. Each of the entry below corresponds to a file.rst in docs/source/.
 .. ----------------------------------------------------------------------
 
-.. toctree::
-   :glob:
-   :maxdepth: 1
-   :caption: Getting Started
-   :hidden:
+..
+   .. toctree::
+      :glob:
+      :maxdepth: 1
+      :caption: Getting Started
+      :hidden:
 
-   overview
-   getting-started
+      overview
+      getting-started
 
-.. toctree::
-   :glob:
-   :maxdepth: 1
-   :caption: Concepts
-   :hidden:
+   .. toctree::
+      :glob:
+      :maxdepth: 1
+      :caption: Concepts
+      :hidden:
 
-   dtypes
-   quantization
-   sparsity
-   performant_kernels
+      dtypes
+      quantization
+      sparsity
+      performant_kernels
 
-.. toctree::
-   :glob:
-   :maxdepth: 1
-   :caption: Tutorials
-   :hidden:
+   .. toctree::
+      :glob:
+      :maxdepth: 1
+      :caption: Tutorials
+      :hidden:
 
-   tutorials/template_tutorial
+      tutorials/template_tutorial
 
 .. toctree::
    :glob:
    :maxdepth: 1
    :caption: API Reference
-   :hidden:
 
    api_ref_intro
    api_ref_sparsity
    api_ref_quantization
    api_ref_dtypes
-   api_ref_kernel
+   ..
+      api_ref_kernel