Skip to content

GitLab

Unverified Commit bb0a8700 authored by Yuge Zhang's avatar Yuge Zhang Committed by GitHub
Browse files

Prettify docs (#4500)

parent 1609e8a4
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 738 additions and 835 deletions
dependencies/develop.txt
View file @ bb0a8700
......@@ -12,3 +12,4 @@ sphinx
sphinx-argparse
sphinx-rtd-theme
sphinxcontrib-websupport
git+https://github.com/bashtage/sphinx-material.git
docs/en_US/_templates/index.html deleted 100644 → 0
View file @ 1609e8a4
This diff is collapsed.
docs/en_US/_templates/layout.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% block sidebartitle %}
{% if logo and theme_logo_only %}
<a href="{{ pathto('index') }}">
{% else %}
<a href="{{ pathto('index') }}" class="icon icon-home"> {{ project }}
{% endif %}
{% if logo %}
{# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
{% endif %}
</a>
{% if theme_display_version %}
{%- set nav_version = version %}
{% if READTHEDOCS and current_version %}
{%- set nav_version = current_version %}
{% endif %}
{% if nav_version %}
<div class="version">
{{ nav_version }}
</div>
{% endif %}
{% endif %}
{% include "searchbox.html" %}
{% endblock %}
docs/en_US/_templates/nnSpider.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2 class="center">nnSpider emoticons</h2>
<ul class="emotion">
<li class="first">
<div>
<a href="{{ pathto('nnSpider/nobug') }}">
<img src="_static/img/NoBug.png" alt="NoBug" />
</a>
</div>
<p class="center">NoBug</p>
</li>
<li class="first">
<div>
<a href="{{ pathto('nnSpider/holiday') }}">
<img src="_static/img/Holiday.png" alt="Holiday" />
</a>
</div>
<p class="center">Holiday</p>
</li>
<li class="first">
<div>
<a href="{{ pathto('nnSpider/errorEmotion') }}">
<img src="_static/img/Error.png" alt="Error" />
</a>
</div>
<p class="center">Error</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/working') }}">
<img class="working" src="_static/img/Working.png" alt="Working" />
</a>
</div>
<p class="center">Working</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/sign') }}">
<img class="sign" src="_static/img/Sign.png" alt="Sign" />
</a>
</div>
<p class="center">Sign</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/crying') }}">
<img class="crying" src="_static/img/Crying.png" alt="Crying" />
</a>
</div>
<p class="center">Crying</p>
</li>
<li class="three">
<div>
<a href="{{ pathto('nnSpider/cut') }}">
<img src="_static/img/Cut.png" alt="Crying" />
</a>
</div>
<p class="center">Cut</p>
</li>
<li class="three">
<div>
<a href="{{ pathto('nnSpider/weaving') }}">
<img class="weaving" src="_static/img/Weaving.png" alt="Weaving" />
</a>
</div>
<p class="center">weaving</p>
</li>
<li class="three">
<div class="comfort">
<a href="{{ pathto('nnSpider/comfort') }}">
<img src="_static/img/Comfort.png" alt="Weaving" />
</a>
</div>
<p class="center">comfort</p>
</li>
<li class="four">
<div>
<a href="{{ pathto('nnSpider/sweat') }}">
<img src="_static/img/Sweat.png" alt="Sweat" />
</a>
</div>
<p class="center">Sweat</p>
</li>
<div class="clear"></div>
</ul>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/comfort.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Comfort</h2>
<div class="details-container">
<img src="../_static/img/Comfort.png" alt="Comfort" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/crying.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Crying</h2>
<div class="details-container">
<img src="../_static/img/Crying.png" alt="Crying" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/cut.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Cut</h2>
<div class="details-container">
<img src="../_static/img/Cut.png" alt="Cut" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/errorEmotion.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Error</h2>
<div class="details-container">
<img src="../_static/img/Error.png" alt="Error" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/holiday.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Holiday</h2>
<div class="details-container">
<img src="../_static/img/Holiday.png" alt="NoBug" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/nobug.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>NoBug</h2>
<div class="details-container">
<img src="../_static/img/NoBug.png" alt="NoBug" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/sign.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Sign</h2>
<div class="details-container">
<img src="../_static/img/Sign.png" alt="Sign" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/sweat.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Sweat</h2>
<div class="details-container">
<img src="../_static/img/Sweat.png" alt="Sweat" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/weaving.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Weaving</h2>
<div class="details-container">
<img src="../_static/img/Weaving.png" alt="Weaving" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/_templates/nnSpider/working.html deleted 100644 → 0
View file @ 1609e8a4
{% extends "!layout.html" %}
{% set title = "Welcome To Neural Network Intelligence !!!"%}
{% block document %}
<h2>Working</h2>
<div class="details-container">
<img src="../_static/img/Working.png" alt="Working" />
</div>
{% endblock %}
\ No newline at end of file
docs/en_US/conf.py
View file @ bb0a8700
......@@ -20,13 +20,15 @@ sys.path.insert(0, os.path.abspath('../..'))
# -- Project information ---------------------------------------------------
from datetime import datetime
project = 'NNI'
copyright = '2021, Microsoft'
copyright = f'{datetime.now().year}, Microsoft'
author = 'Microsoft'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
# FIXME: this should be written somewhere globally
release = 'v2.6'
# -- General configuration ---------------------------------------------------
......@@ -54,14 +56,14 @@ extensions = [
autodoc_mock_imports = ['apex', 'nni_node', 'tensorrt', 'pycuda', 'nn_meter']
# 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']
# The master toctree document.
master_doc = 'contents'
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -78,38 +80,64 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'Release_v1.0.md', '**.i
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
# -- Options for HTML output -------------------------------------------------
html_additional_pages = {
'index': 'index.html',
'nnSpider': 'nnSpider.html',
'nnSpider/nobug': 'nnSpider/nobug.html',
'nnSpider/holiday': 'nnSpider/holiday.html',
'nnSpider/errorEmotion': 'nnSpider/errorEmotion.html',
'nnSpider/working': 'nnSpider/working.html',
'nnSpider/sign': 'nnSpider/sign.html',
'nnSpider/crying': 'nnSpider/crying.html',
'nnSpider/cut': 'nnSpider/cut.html',
'nnSpider/weaving': 'nnSpider/weaving.html',
'nnSpider/comfort': 'nnSpider/comfort.html',
'nnSpider/sweat': 'nnSpider/sweat.html'
# HTML logo
html_logo = '../img/nni_icon.svg'
}
# -- Options for HTML output -------------------------------------------------
# HTML favicon
html_favicon = '../img/favicon.ico'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'sphinx_material'
# 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 = {
'logo_only': True,
# Set the name of the project to appear in the navigation.
'nav_title': 'Neural Network Intelligence',
# Set you GA account ID to enable tracking
'google_analytics_account': 'UA-136029994-1',
# Specify a base_url used to generate sitemap.xml. If not
# specified, then no sitemap will be built.
'base_url': 'https://nni.readthedocs.io/',
# Set the color and the accent color
# We can't have our customized themes currently
# Remember to update static/css/material_custom.css when this is updated.
'color_primary': 'indigo',
'color_accent': 'pink',
# Set the repo location to get a badge with stats
'repo_url': 'https://github.com/microsoft/nni/',
'repo_name': 'nni',
# Visible levels of the global TOC; -1 means unlimited
'globaltoc_depth': 3,
'version_dropdown': True,
# This is a placeholder, which should be replaced later.
'version_info': {
'current': '/'
},
# Text to appear at the top of the home page in a "hero" div.
'heroes': {
# We can have heroes for the home pages of HPO, NAS, Compression in future.
'index': 'An open source AutoML toolkit for neural architecture search, model compression and hyper-parameter tuning.'
}
}
# Disable show source link.
html_show_sourcelink = False
# 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".
......@@ -123,11 +151,22 @@ html_static_path = ['../static']
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
html_sidebars = {
"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
}
html_logo = '../img/nni_logo_dark.png'
html_title = 'An open source AutoML toolkit for neural architecture search, model compression and hyper-parameter tuning (%s %s)' % \
(project, release)
html_title = 'Neural Network Intelligence'
# Add extra css files and js files
html_css_files = [
'css/material_custom.css',
'css/material_dropdown.css',
'css/index_page.css',
]
html_js_files = [
'js/version.js',
'js/github.js',
]
# -- Options for HTMLHelp output ---------------------------------------------
......@@ -210,7 +249,3 @@ git_commit_id = subprocess.check_output(['git', 'rev-parse', 'HEAD']).decode().s
extlinks = {
'githublink': ('https://github.com/microsoft/nni/blob/' + git_commit_id + '/%s', 'Github link: ')
}
# -- Extension configuration -------------------------------------------------
def setup(app):
app.add_css_file('css/custom.css')
docs/en_US/contents.rst deleted 100644 → 0
View file @ 1609e8a4
###########################
Neural Network Intelligence
###########################
.. toctree::
:caption: Table of Contents
:maxdepth: 2
:titlesonly:
Overview
Installation <installation>
QuickStart <Tutorial/QuickStart>
Auto (Hyper-parameter) Tuning <hyperparameter_tune>
Neural Architecture Search <nas>
Model Compression <model_compression>
Feature Engineering <feature_engineering>
References <reference>
Use Cases and Solutions <CommunitySharings/community_sharings>
Research and Publications <ResearchPublications>
FAQ <Tutorial/FAQ>
How to Contribute <contribution>
Change Log <Release>
docs/en_US/index.rst 0 → 100644
View file @ bb0a8700
This diff is collapsed.
docs/en_US/nnSpider.rst 0 → 100644
View file @ bb0a8700
:orphan:
.. raw:: html
<h2 class="center">nnSpider emoticons</h2>
<ul class="emotion">
<li class="first">
<div>
<a href="{{ pathto('nnSpider/nobug') }}">
<img src="_static/img/NoBug.png" alt="NoBug" />
</a>
</div>
<p class="center">NoBug</p>
</li>
<li class="first">
<div>
<a href="{{ pathto('nnSpider/holiday') }}">
<img src="_static/img/Holiday.png" alt="Holiday" />
</a>
</div>
<p class="center">Holiday</p>
</li>
<li class="first">
<div>
<a href="{{ pathto('nnSpider/errorEmotion') }}">
<img src="_static/img/Error.png" alt="Error" />
</a>
</div>
<p class="center">Error</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/working') }}">
<img class="working" src="_static/img/Working.png" alt="Working" />
</a>
</div>
<p class="center">Working</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/sign') }}">
<img class="sign" src="_static/img/Sign.png" alt="Sign" />
</a>
</div>
<p class="center">Sign</p>
</li>
<li class="second">
<div>
<a href="{{ pathto('nnSpider/crying') }}">
<img class="crying" src="_static/img/Crying.png" alt="Crying" />
</a>
</div>
<p class="center">Crying</p>
</li>
<li class="three">
<div>
<a href="{{ pathto('nnSpider/cut') }}">
<img src="_static/img/Cut.png" alt="Crying" />
</a>
</div>
<p class="center">Cut</p>
</li>
<li class="three">
<div>
<a href="{{ pathto('nnSpider/weaving') }}">
<img class="weaving" src="_static/img/Weaving.png" alt="Weaving" />
</a>
</div>
<p class="center">weaving</p>
</li>
<li class="three">
<div class="comfort">
<a href="{{ pathto('nnSpider/comfort') }}">
<img src="_static/img/Comfort.png" alt="Weaving" />
</a>
</div>
<p class="center">comfort</p>
</li>
<li class="four">
<div>
<a href="{{ pathto('nnSpider/sweat') }}">
<img src="_static/img/Sweat.png" alt="Sweat" />
</a>
</div>
<p class="center">Sweat</p>
</li>
<div class="clear"></div>
</ul>
docs/en_US/nnSpider/comfort.rst 0 → 100644
View file @ bb0a8700
:orphan:
.. raw:: html
<h2>Comfort</h2>
<div class="details-container">
<img src="../_static/img/Comfort.png" alt="Comfort" />
</div>
docs/en_US/nnSpider/crying.rst 0 → 100644
View file @ bb0a8700
:orphan:
.. raw:: html
<h2>Crying</h2>
<div class="details-container">
<img src="../_static/img/Crying.png" alt="Crying" />
</div>
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