Unverified Commit 136ca605 authored by Aditya Oke's avatar Aditya Oke Committed by GitHub
Browse files

Add sphinx Index at the bottom of the index.html page (#3894)

parent a0cd96ff
...@@ -27,9 +27,7 @@ import pytorch_sphinx_theme ...@@ -27,9 +27,7 @@ import pytorch_sphinx_theme
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # Required version of sphinx is set from docs/requirements.txt
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
...@@ -40,13 +38,12 @@ extensions = [ ...@@ -40,13 +38,12 @@ extensions = [
'sphinx.ext.doctest', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.duration', 'sphinx.ext.duration',
'sphinx_gallery.gen_gallery', 'sphinx_gallery.gen_gallery',
"sphinx_copybutton" 'sphinx_copybutton',
] ]
sphinx_gallery_conf = { sphinx_gallery_conf = {
...@@ -60,14 +57,16 @@ napoleon_use_ivar = True ...@@ -60,14 +57,16 @@ napoleon_use_ivar = True
napoleon_numpy_docstring = False napoleon_numpy_docstring = False
napoleon_google_docstring = True napoleon_google_docstring = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# #
# source_suffix = ['.rst', '.md'] source_suffix = {
source_suffix = '.rst' '.rst': 'restructuredtext',
}
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
...@@ -147,7 +146,6 @@ htmlhelp_basename = 'PyTorchdoc' ...@@ -147,7 +146,6 @@ htmlhelp_basename = 'PyTorchdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
# #
...@@ -166,6 +164,7 @@ latex_elements = { ...@@ -166,6 +164,7 @@ latex_elements = {
# 'figure_align': 'htbp', # 'figure_align': 'htbp',
} }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
......
...@@ -58,3 +58,9 @@ architectures, and common image transformations for computer vision. ...@@ -58,3 +58,9 @@ architectures, and common image transformations for computer vision.
TorchElastic <https://pytorch.org/elastic/> TorchElastic <https://pytorch.org/elastic/>
TorchServe <https://pytorch.org/serve> TorchServe <https://pytorch.org/serve>
PyTorch on XLA Devices <http://pytorch.org/xla/> PyTorch on XLA Devices <http://pytorch.org/xla/>
Indices
-------
* :ref:`genindex`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment