diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..584a142 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing + +## Documentation + +### Conda environment for documentation + +Install miniconda first. + +```bash +conda env create -f environment.yml +conda activate docs +``` + +### Generating documentation + +Install Sphinx and plugins: +```bash +pip install sphinx autodoc recommonmark sphinx-rtd-theme +``` + +Generate HTML: +```bash +cd docs +make html +``` + +Run HTTP server: +```bash +cd docs/_build/html +python -m http.server 8000 +``` + +Don't forget to change the version in `docs/conf.py` before generating. +```python +release = "" +``` + +Generated documentation will be in `docs/_build/html`. + +### Uploading to GitHub Pages + +Documentation for GitHub Pages is placed in following branch +[`gh-pages`](https://github.com/IntelPython/numba-dppy/tree/gh-pages). + +Folders: +- `dev` folder contains current documentation for default branch. +- `0.12.0` folder and other similar folders contain documentation for releases. +- `latest` folder is a link to the latest release folder. + +Copy generated documentation into corresponding folder and create pull request +to `gh-pages` branch. diff --git a/README.md b/README.md index 7b49530..c240f0a 100644 --- a/README.md +++ b/README.md @@ -1 +1,5 @@ -# DPPY \ No newline at end of file +# DPPY + +## Contributing + +For contributing to this repository see [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..e35d885 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build 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..a577230 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,64 @@ +# 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('.')) + +import sphinx_rtd_theme + +# -- Project information ----------------------------------------------------- + +project = "DPPY" +copyright = "2021, Intel" +author = "Intel" + +# The full version, including alpha/beta/rc tags +release = "0.0.1" + + +# -- 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 = [ + "recommonmark", + "sphinx_rtd_theme", + "sphinx.ext.autodoc", + "sphinx.ext.todo", +] + +todo_include_todos = True + +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# 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 ------------------------------------------------- + +# 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"] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..ac81a52 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,34 @@ +.. documentation master file, created by + sphinx-quickstart. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to DPPY documentation! +====================================== + +... + +About +===== + +... + +License +======= + +... + +Indices and tables +================== + +.. only:: builder_html + + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` + +.. only:: not builder_html + + * :ref:`modindex` + +.. |reg| unicode:: U+000AE .. REGISTERED SIGN diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..2119f51 --- /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.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/environment.yml b/environment.yml new file mode 100644 index 0000000..57adc9a --- /dev/null +++ b/environment.yml @@ -0,0 +1,11 @@ +name: docs +channels: + - defaults +dependencies: + - python=3.9 + - pip + - pip: + - sphinx + - autodoc + - recommonmark + - sphinx-rtd-theme