From 7397cfdba2029e3db0ae36128e3004a8f446c329 Mon Sep 17 00:00:00 2001 From: Abhinav Bhatele Date: Fri, 22 Apr 2022 00:17:26 -0400 Subject: [PATCH] add structure for AxoNN docs (#15) --- docs/Makefile | 20 +++++++ docs/conf.py | 109 +++++++++++++++++++++++++++++++++++++++ docs/getting_started.rst | 30 +++++++++++ docs/index.rst | 30 +++++++++++ docs/make.bat | 35 +++++++++++++ 5 files changed, 224 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/getting_started.rst create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /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 = . +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/conf.py b/docs/conf.py new file mode 100644 index 0000000..1f16863 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,109 @@ +# Copyright 2022 Parallel Software and Systems Group, University of Maryland. +# See the top-level LICENSE file for details. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +# 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('.')) + +# The name of the Pygments (syntax highlighting) style to use. +from pygments.styles.default import DefaultStyle +from pygments.token import Generic + +import pkg_resources + + +# -- Project information ----------------------------------------------------- + +project = "axonn" +copyright = "2022, Parallel Software and Systems Group, University of Maryland" +author = "Siddharth Singh, Abhinav Bhatele" + +# The full version, including alpha/beta/rc tags +release = "0.1.0" + + +# -- 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.todo", + "sphinx.ext.imgmath", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", + "sphinx.ext.napoleon", +] + +# 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"] + + +# modifications to the default style +class AxonnStyle(DefaultStyle): + styles = DefaultStyle.styles.copy() + background_color = "#f4f4f8" + styles[Generic.Output] = "#355" + styles[Generic.Prompt] = "bold #346ec9" + + +dist = pkg_resources.Distribution(__file__) +sys.path.append(".") # make 'conf' module findable +ep = pkg_resources.EntryPoint.parse("axonn = conf:AxonnStyle", dist=dist) +dist._ep_map = {"pygments.styles": {"plugin1": ep}} +pkg_resources.working_set.add(dist) + +pygments_style = "axonn" + + +# -- 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 = "sphinx_rtd_theme" + +# 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 = { + "canonical_url": "", + "analytics_id": "", + "logo_only": True, + "display_version": True, + "prev_next_buttons_location": "bottom", + "style_external_links": False, + # Toc options + "collapse_navigation": True, + "sticky_navigation": True, + "navigation_depth": 4, + "includehidden": True, + "titles_only": 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". +html_static_path = ["_static"] diff --git a/docs/getting_started.rst b/docs/getting_started.rst new file mode 100644 index 0000000..0a6b10e --- /dev/null +++ b/docs/getting_started.rst @@ -0,0 +1,30 @@ +.. Copyright 2022 Parallel Software and Systems Group, University of Maryland. + See the top-level LICENSE file for details. + + SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +*************** +Getting Started +*************** + +Prerequisites +============= + +AxoNN has the following minimum requirements, which must be installed before +AxoNN is run: + +#. Python 2 (2.7) or 3 (3.5 - 3.10) +#. PyTorch +#. mpi4py + +Installation +============ + +Install and Build AxoNN +----------------------- + + +Check Installation +------------------ + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7bb76cd --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,30 @@ +.. Copyright 2022 Parallel Software and Systems Group, University of Maryland. + See the top-level LICENSE file for details. + + SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +.. axonn documentation master file, created by + sphinx-quickstart on Thu Apr 21 19:19:08 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +##### +AxoNN +##### + +AxoNN is a parallel framework for training deep neural networks. + +.. toctree:: + :maxdepth: 2 + :caption: User Docs + + getting_started + + +################## +Indices and tables +################## + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..153be5e --- /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=. +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.https://www.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