From 341340a9a4d735c5ab5f0c062208027df312ac01 Mon Sep 17 00:00:00 2001 From: WeichenXu Date: Wed, 2 Sep 2020 17:22:20 +0800 Subject: [PATCH] [ML-11959] Create docs (#235) Create docs by sphinx. --- .gitignore | 4 +-- .travis.yml | 4 +++ docs/Makefile | 20 ++++++++++++ docs/make.bat | 35 +++++++++++++++++++++ docs/source/conf.py | 56 +++++++++++++++++++++++++++++++++ docs/source/index.rst | 20 ++++++++++++ docs/source/modules.rst | 7 +++++ docs/source/sparkdl.horovod.rst | 21 +++++++++++++ docs/source/sparkdl.rst | 18 +++++++++++ 9 files changed, 182 insertions(+), 3 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/sparkdl.horovod.rst create mode 100644 docs/source/sparkdl.rst diff --git a/.gitignore b/.gitignore index b1bce9a0..42bbb019 100644 --- a/.gitignore +++ b/.gitignore @@ -6,9 +6,7 @@ python/.setup.sh build/*.jar -docs/_site -docs/api -README.org +docs/build # python *.pyc diff --git a/.travis.yml b/.travis.yml index 4f36b8b9..50a5918b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,5 +5,9 @@ language: python python: - "3.6" +install: + - pip install sphinx + script: + - pushd docs && make html && popd - pytest diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d0c3cbf1 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# 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 = source +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) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..6247f7e2 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +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 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..35775ebd --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,56 @@ +# 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 = 'Spark deep learning' +copyright = '2020, Weichen Xu' +author = 'Weichen Xu' + +# The full version, including alpha/beta/rc tags +release = '2.0.0-SNAPSHOT' + + +# -- 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' +] + +# 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 = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# 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'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..caf7eecb --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. Spark deep learning documentation master file, created by + sphinx-quickstart on Wed Sep 2 16:15:38 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Spark deep learning's documentation! +=============================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..16ce649e --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +sparkdl +======= + +.. toctree:: + :maxdepth: 4 + + sparkdl diff --git a/docs/source/sparkdl.horovod.rst b/docs/source/sparkdl.horovod.rst new file mode 100644 index 00000000..f0ce974a --- /dev/null +++ b/docs/source/sparkdl.horovod.rst @@ -0,0 +1,21 @@ +sparkdl.horovod package +======================= + +Submodules +---------- + +sparkdl.horovod.runner\_base module +----------------------------------- + +.. automodule:: sparkdl.horovod.runner_base + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sparkdl.horovod + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sparkdl.rst b/docs/source/sparkdl.rst new file mode 100644 index 00000000..6cc9babe --- /dev/null +++ b/docs/source/sparkdl.rst @@ -0,0 +1,18 @@ +sparkdl package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + sparkdl.horovod + +Module contents +--------------- + +.. automodule:: sparkdl + :members: + :undoc-members: + :show-inheritance: