Deploy docs in CI

.gitlab-ci.yml

@@ -5,6 +5,7 @@ variables:
 stages:
     - linting
     - test
+    - deploy
 
 before_script:
   - echo $PATH
@@ -14,7 +15,8 @@ before_script:
   - pip --version
   - python -c "import torch; print(torch.__version__)"
 
-.linting_template: &linting_template_def
+linting:
+  image: $PYTORCH_IMAGE
   stage: linting
   script:
     - pip install flake8 yapf isort
@@ -34,14 +36,6 @@ before_script:
     - coverage run --branch --source mmaction -m pytest tests/
     - coverage report -m
 
-linting:pytorch1.3-cuda10:
-  image: $PYTORCH_IMAGE
-  <<: *linting_template_def
-
-linting:pat0.6.0dev-cuda9:
-  image: $PARROTS_IMAGE
-  <<: *linting_template_def
-
 test:pytorch1.3-cuda10:
   image: $PYTORCH_IMAGE
   <<: *test_template_def
@@ -49,3 +43,20 @@ test:pytorch1.3-cuda10:
 test:pat0.6.0dev-cuda9:
   image: $PARROTS_IMAGE
   <<: *test_template_def
+
+pages:
+  image: $PYTORCH_IMAGE
+  stage: deploy
+  script:
+    - pip install sphinx sphinx_rtd_theme recommonmark
+    - cd docs
+    - make html
+    - cd ..
+    - mkdir -p ./public
+    - cp -r docs/_build/html/* ./public
+    - ls ./public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

docs/Makefile

+# 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
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# 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)

docs/api.rst

+API Documentation
+=================
+
+mmaction.core
+-------------
+.. automodule:: mmaction.core
+    :members:
+
+
+mmaction.models
+---------------
+
+recognizers
+^^^^^^^^^^^
+.. automodule:: mmaction.models.recognizers
+    :members:
+
+localizers
+^^^^^^^^^^^
+.. automodule:: mmaction.models.localizers
+    :members:
+
+common
+^^^^^^^
+.. automodule:: mmaction.models.common
+    :members:
+
+backbones
+^^^^^^^^^
+.. automodule:: mmaction.models.backbones
+    :members:
+
+heads
+^^^^^
+.. automodule:: mmaction.models.heads
+    :members:
+
+losses
+^^^^^^
+.. automodule:: mmaction.models.losses
+    :members:
+
+
+mmaction.datasets
+-----------------
+.. automodule:: mmaction.datasets
+    :members:
+
+
+mmaction.utils
+---------------
+.. automodule:: mmaction.utils
+    :members:

docs/conf.py

+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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('..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'MMAction'
+copyright = '2020, OpenMMLab'
+author = 'MMAction Authors'
+
+# The full version, including alpha/beta/rc tags
+with open('../mmaction/VERSION', 'r') as f:
+    release = f.read().strip()
+
+# -- General configuration ---------------------------------------------------
+
+# 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.napoleon', 'sphinx.ext.viewcode',
+    'recommonmark'
+]
+
+autodoc_mock_imports = [
+    'mmaction.version', 'torch', 'torchvision', 'cv2', 'mmcv', 'numpy'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# 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']

docs/index.rst

+Welcome to MMAction's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+
+   api.rst
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

docs/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd