"examples/tutorial/vscode:/vscode.git/clone" did not exist on "d9bf83e084dd82daaa05cd68e58fe66a24fd5a23"
Unverified Commit 9e3b8b7a authored by Frank Lee's avatar Frank Lee Committed by GitHub
Browse files

[doc] removed read-the-docs (#2932)

parent 77b88a38
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements/requirements.txt
- requirements: docs/requirements.txt
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = .build
SPHINXAPIDOC ?= sphinx-apidoc
SPHINX_APIDOC_OPTIONS = members
SPHINX_APIDOC_TEMPLATEDIR = _templates/apidoc
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile apidoc
apidoc:
@SPHINX_APIDOC_OPTIONS=$(SPHINX_APIDOC_OPTIONS) $(SPHINXAPIDOC) -f -T -e -M -d 2 -t $(SPHINX_APIDOC_TEMPLATEDIR) -o ./colossalai ../colossalai
# @$(SPHINXAPIDOC) -f -o ./model_zoo ../model_zoo
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.wy-nav-content {
max-width: 80%;
}
\ No newline at end of file
{%- if show_headings %}
{{- basename | e | heading }}
{% endif -%}
.. automodule:: {{ qualname }}
{%- for option in automodule_options %}
:{{ option }}:
{%- endfor %}
{%- macro automodule(modname, options) -%}
.. automodule:: {{ modname }}
{%- for option in options %}
:{{ option }}:
{%- endfor %}
{%- endmacro %}
{%- macro toctree(docnames) -%}
.. toctree::
:maxdepth: {{ maxdepth }}
{% for docname in docnames %}
{{ docname }}
{%- endfor %}
{%- endmacro %}
{%- if is_namespace %}
{{- pkgname | e | heading }}
{% else %}
{{- pkgname | e | heading }}
{% endif %}
{%- if is_namespace %}
.. py:module:: {{ pkgname }}
{% endif %}
{%- if modulefirst and not is_namespace %}
{{ automodule(pkgname, automodule_options) }}
{% endif %}
{%- if subpackages %}
{{ toctree(subpackages) }}
{% endif %}
{%- if submodules %}
{% if separatemodules %}
{{ toctree(submodules) }}
{% else %}
{%- for submodule in submodules %}
{% if show_headings %}
{{- submodule | e | heading(2) }}
{% endif %}
{{ automodule(submodule, automodule_options) }}
{% endfor %}
{%- endif %}
{%- endif %}
{%- if not modulefirst and not is_namespace %}
Module contents
---------------
{{ automodule(pkgname, automodule_options) }}
{% endif %}
{{ header | heading }}
.. toctree::
:maxdepth: {{ maxdepth }}
{% for docname in docnames %}
{{ docname }}
{%- endfor %}
colossalai.amp.amp\_type
========================
.. automodule:: colossalai.amp.amp_type
:members:
colossalai.amp.apex\_amp.apex\_amp
==================================
.. automodule:: colossalai.amp.apex_amp.apex_amp
:members:
colossalai.amp.apex\_amp
========================
.. automodule:: colossalai.amp.apex_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.apex_amp.apex_amp
colossalai.amp.naive\_amp.grad\_scaler
======================================
.. automodule:: colossalai.amp.naive_amp.grad_scaler
:members:
colossalai.amp.naive\_amp.naive\_amp
====================================
.. automodule:: colossalai.amp.naive_amp.naive_amp
:members:
colossalai.amp.naive\_amp
=========================
.. automodule:: colossalai.amp.naive_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.naive_amp.grad_scaler
.. toctree::
:maxdepth: 2
colossalai.amp.naive_amp.naive_amp
colossalai.amp
==============
.. automodule:: colossalai.amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.apex_amp
colossalai.amp.naive_amp
colossalai.amp.torch_amp
.. toctree::
:maxdepth: 2
colossalai.amp.amp_type
colossalai.amp.torch\_amp
=========================
.. automodule:: colossalai.amp.torch_amp
:members:
.. toctree::
:maxdepth: 2
colossalai.amp.torch_amp.torch_amp
colossalai.amp.torch\_amp.torch\_amp
====================================
.. automodule:: colossalai.amp.torch_amp.torch_amp
:members:
colossalai.builder.builder
==========================
.. automodule:: colossalai.builder.builder
:members:
colossalai.builder
==================
.. automodule:: colossalai.builder
:members:
.. toctree::
:maxdepth: 2
colossalai.builder.builder
colossalai.cli.benchmark.benchmark
==================================
.. automodule:: colossalai.cli.benchmark.benchmark
:members:
colossalai.cli.benchmark.models
===============================
.. automodule:: colossalai.cli.benchmark.models
:members:
colossalai.cli.benchmark
========================
.. automodule:: colossalai.cli.benchmark
:members:
.. toctree::
:maxdepth: 2
colossalai.cli.benchmark.benchmark
colossalai.cli.benchmark.models
colossalai.cli.benchmark.utils
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