From 6376ba5cf605f8d9f0408314805bc75e14705b0c Mon Sep 17 00:00:00 2001 From: k-dominik Date: Fri, 5 Jul 2019 13:54:54 +0200 Subject: [PATCH 1/2] Added basic sphinx docs generation * `sphinx-quickstart` * config mods * `sphinx-apidoc ../ndstructs -o source --- .gitignore | 1 + docs/Makefile | 20 ++++++++++++ docs/conf.py | 57 +++++++++++++++++++++++++++++++++ docs/index.rst | 20 ++++++++++++ docs/make.bat | 35 ++++++++++++++++++++ docs/source/modules.rst | 7 ++++ docs/source/ndstructs.rst | 37 +++++++++++++++++++++ docs/source/ndstructs.utils.rst | 22 +++++++++++++ 8 files changed, 199 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 docs/source/modules.rst create mode 100644 docs/source/ndstructs.rst create mode 100644 docs/source/ndstructs.utils.rst diff --git a/.gitignore b/.gitignore index c18dd8d..03f4ba2 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ __pycache__/ +docs/_* \ No newline at end of file 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..6d8073b --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,57 @@ +# 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: +# http://www.sphinx-doc.org/en/master/config + +# -- 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 = 'ndstructs' +copyright = '2019, Tomaz Vieira' +author = 'Tomaz Vieira' + +# The full version, including alpha/beta/rc tags +release = '0.0.1dev0' + + +# -- 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', +] + +# 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..7ad6038 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. ndstructs documentation master file, created by + sphinx-quickstart on Fri Jul 5 10:54:03 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to ndstructs's documentation! +===================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +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..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/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..071f103 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +ndstructs +========= + +.. toctree:: + :maxdepth: 4 + + ndstructs diff --git a/docs/source/ndstructs.rst b/docs/source/ndstructs.rst new file mode 100644 index 0000000..3690aee --- /dev/null +++ b/docs/source/ndstructs.rst @@ -0,0 +1,37 @@ +ndstructs package +================= + +Subpackages +----------- + +.. toctree:: + + ndstructs.utils + +Submodules +---------- + +ndstructs.array5D module +------------------------ + +.. automodule:: ndstructs.array5D + :members: + :undoc-members: + :show-inheritance: + +ndstructs.point5D module +------------------------ + +.. automodule:: ndstructs.point5D + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: ndstructs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/ndstructs.utils.rst b/docs/source/ndstructs.utils.rst new file mode 100644 index 0000000..e883a10 --- /dev/null +++ b/docs/source/ndstructs.utils.rst @@ -0,0 +1,22 @@ +ndstructs.utils package +======================= + +Submodules +---------- + +ndstructs.utils.JsonSerializable module +--------------------------------------- + +.. automodule:: ndstructs.utils.JsonSerializable + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: ndstructs.utils + :members: + :undoc-members: + :show-inheritance: From 1e240992579fa841af67c7319d172a236a5a6689 Mon Sep 17 00:00:00 2001 From: k-dominik Date: Fri, 5 Jul 2019 14:07:37 +0200 Subject: [PATCH 2/2] added readthedocs config --- .readthedocs.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..41bd402 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,8 @@ +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +conda: + environment: dev/environment-dev.yaml