Landingpage update (#2418)

* Landing page update

PR to update Landing page to make it easier to navigate.

* Update performance_guide.md

* Update conf.py

* Update conf.py

* Update custom_directives.py

* Update requirements.txt

docs/conf.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
 # PyTorch documentation build configuration file, created by
@@ -17,84 +16,84 @@
 # 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 torch
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("."))
+
 
 import pytorch_sphinx_theme
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-needs_sphinx = '3.0.3'
+needs_sphinx = "3.0.3"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosectionlabel',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
-    'sphinxcontrib.katex',
-    'recommonmark',
-    'sphinx_markdown_tables'
-
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.katex",
+    "recommonmark",
+    "sphinx_markdown_tables",
 ]
 
 # katex options
 #
 #
 
-katex_options = r'''
+katex_options = r"""
 delimiters : [
    {left: "$$", right: "$$", display: true},
    {left: "\\(", right: "\\)", display: false},
    {left: "\\[", right: "\\]", display: true}
 ]
-'''
+"""
 
 napoleon_use_ivar = True
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.txt': 'markdown',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
 }
 # source_suffix = '.rst'
 
 
 # The master toctree document.
-master_doc = 'contents'
+master_doc = "contents"
 
 # General information about the project.
-project = 'PyTorch/Serve'
-copyright = '2020, PyTorch Serve Contributors'
-author = 'PyTorch Serve Contributors'
+project = "PyTorch/Serve"
+copyright = "2020, PyTorch Serve Contributors"
+author = "PyTorch Serve Contributors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
 # TODO: change to [:2] at v1.0
-version = 'master '
+version = "master "
 # The full version, including alpha/beta/rc tags.
 # TODO: verify this works as expected
-release = 'master'
+release = "master"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -109,7 +108,7 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
@@ -120,46 +119,47 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'pytorch_sphinx_theme'
+html_theme = "pytorch_sphinx_theme"
 html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    'pytorch_project': 'audio',
-    'collapse_navigation': True,
-    'display_version': True,
-    'logo_only': True,
+    "pytorch_project": "audio",
+    "collapse_navigation": True,
+    "display_version": True,
+    "logo_only": True,
 }
 
-html_logo = '_static/img/pytorch-logo-dark.svg'
+html_logo = "_static/img/pytorch-logo-dark.svg"
 
 # 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"]
+
 
 def setup(app):
     # NOTE: in Sphinx 1.8+ `html_css_files` is an official configuration value
     # and can be moved outside of this function (and the setup(app) function
     # can be deleted).
     html_css_files = [
-        'https://cdn.jsdelivr.net/npm/katex@0.10.0-beta/dist/katex.min.css'
+        "https://cdn.jsdelivr.net/npm/katex@0.10.0-beta/dist/katex.min.css"
     ]
 
     # In Sphinx 1.8 it was renamed to `add_css_file`, 1.7 and prior it is
     # `add_stylesheet` (deprecated in 1.8).
-    add_css = getattr(app, 'add_css_file')
+    add_css = getattr(app, "add_css_file")
     for css_file in html_css_files:
         add_css(css_file)
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'TorchServedoc'
+htmlhelp_basename = "TorchServedoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -168,15 +168,12 @@ def setup(app):
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -186,19 +183,21 @@ def setup(app):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pytorch.tex', 'Torchserve Documentation',
-     'Torch Contributors', 'manual'),
+    (
+        master_doc,
+        "pytorch.tex",
+        "Torchserve Documentation",
+        "Torch Contributors",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'Torchserve', 'Torchserve Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "Torchserve", "Torchserve Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -221,7 +220,28 @@ def setup(app):
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'numpy': ('https://docs.scipy.org/doc/numpy/', None),
-    'torch': ('https://pytorch.org/docs/stable/', None),
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
+    "torch": ("https://pytorch.org/docs/stable/", None),
 }
+
+
+# Custom directives defintions to create cards on main TorchServe page
+
+from custom_directives import (
+    CustomCardEnd,
+    CustomCardItem,
+    CustomCardStart,
+    SupportedDevices,
+    SupportedProperties,
+)
+from docutils.parsers import rst
+
+# Register custom directives
+
+
+rst.directives.register_directive("devices", SupportedDevices)
+rst.directives.register_directive("properties", SupportedProperties)
+rst.directives.register_directive("customcardstart", CustomCardStart)
+rst.directives.register_directive("customcarditem", CustomCardItem)
+rst.directives.register_directive("customcardend", CustomCardEnd)

docs/contents.rst

@@ -1,11 +1,11 @@
 .. toctree::
   :maxdepth: 0
-  :numbered:
   :caption: Contents:
   :titlesonly:
 
   index
   Troubleshooting
+  performance_guide
   batch_inference_with_ts
   code_coverage
   configuration
@@ -18,12 +18,12 @@
   server
   mps
   snapshot
-  sphinx/requirements
   torchserve_on_win_native
   torchserve_on_wsl
   use_cases
   workflows
   large_model_inference
+  FAQs
 
 .. toctree::
   :maxdepth: 0