Commit dfdb6ee4 authored by payno's avatar payno
Browse files

[doc] add structure for documentation

parent a726e33e
# 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)
# 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 = 'pypushflow'
copyright = '2020, O. Svensson, H. Payno'
author = 'O. Svensson, H. Payno'
# The full version, including alpha/beta/rc tags
release = '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 = [
'sphinx.ext.autodoc',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'python'
# 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']
\ No newline at end of file
.. pypushflow documentation master file, created by
sphinx-quickstart on Tue Apr 7 08:55:59 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pypushflow's documentation!
======================================
.. toctree::
:maxdepth: 2
:caption: Contents:
.. toctree::
:hidden:
modules/index.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@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
.. _modindex:
pypushflow
==========
pypushflow is module providing tools for running push workflows.
.. toctree::
:maxdepth: 4
pypushflow
pypushflow.representation package
=================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
pypushflow.representation.scheme
Module contents
---------------
.. automodule:: pypushflow.representation
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme package
========================================
Submodules
----------
pypushflow.representation.scheme.json\_parser module
----------------------------------------------------
.. automodule:: pypushflow.representation.scheme.json_parser
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme.link module
--------------------------------------------
.. automodule:: pypushflow.representation.scheme.link
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme.moml\_parser module
----------------------------------------------------
.. automodule:: pypushflow.representation.scheme.moml_parser
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme.node module
--------------------------------------------
.. automodule:: pypushflow.representation.scheme.node
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme.ows\_parser module
---------------------------------------------------
.. automodule:: pypushflow.representation.scheme.ows_parser
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme.parser module
----------------------------------------------
.. automodule:: pypushflow.representation.scheme.parser
:members:
:undoc-members:
:show-inheritance:
pypushflow.representation.scheme.scheme module
----------------------------------------------
.. automodule:: pypushflow.representation.scheme.scheme
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: pypushflow.representation.scheme
:members:
:undoc-members:
:show-inheritance:
pypushflow package
==================
Subpackages
-----------
.. toctree::
:maxdepth: 4
pypushflow.representation
pypushflow.test
Submodules
----------
pypushflow.AbstractActor module
-------------------------------
.. automodule:: pypushflow.AbstractActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.ErrorHandler module
------------------------------
.. automodule:: pypushflow.ErrorHandler
:members:
:undoc-members:
:show-inheritance:
pypushflow.ForkActor module
---------------------------
.. automodule:: pypushflow.ForkActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.JoinActor module
---------------------------
.. automodule:: pypushflow.JoinActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.PythonActor module
-----------------------------
.. automodule:: pypushflow.PythonActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.RequestStatus module
-------------------------------
.. automodule:: pypushflow.RequestStatus
:members:
:undoc-members:
:show-inheritance:
pypushflow.RouterActor module
-----------------------------
.. automodule:: pypushflow.RouterActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.StartActor module
----------------------------
.. automodule:: pypushflow.StartActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.StopActor module
---------------------------
.. automodule:: pypushflow.StopActor
:members:
:undoc-members:
:show-inheritance:
pypushflow.Submodel module
--------------------------
.. automodule:: pypushflow.Submodel
:members:
:undoc-members:
:show-inheritance:
pypushflow.UtilsMongoDb module
------------------------------
.. automodule:: pypushflow.UtilsMongoDb
:members:
:undoc-members:
:show-inheritance:
pypushflow.Workflow module
--------------------------
.. automodule:: pypushflow.Workflow
:members:
:undoc-members:
:show-inheritance:
pypushflow.version module
-------------------------
.. automodule:: pypushflow.version
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: pypushflow
:members:
:undoc-members:
:show-inheritance:
pypushflow.test package
=======================
Submodules
----------
pypushflow.test.TestWorkflow module
-----------------------------------
.. automodule:: pypushflow.test.TestWorkflow
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.pythonActor1 module
-----------------------------------
.. automodule:: pypushflow.test.pythonActor1
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.pythonActor2 module
-----------------------------------
.. automodule:: pypushflow.test.pythonActor2
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.pythonActorTest module
--------------------------------------
.. automodule:: pypushflow.test.pythonActorTest
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.pythonErrorHandlerTest module
---------------------------------------------
.. automodule:: pypushflow.test.pythonErrorHandlerTest
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.test\_Actors module
-----------------------------------
.. automodule:: pypushflow.test.test_Actors
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.test\_UtilsMongoDb module
-----------------------------------------
.. automodule:: pypushflow.test.test_UtilsMongoDb
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.test\_Workflows module
--------------------------------------
.. automodule:: pypushflow.test.test_Workflows
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.test\_representation module
-------------------------------------------
.. automodule:: pypushflow.test.test_representation
:members:
:undoc-members:
:show-inheritance:
pypushflow.test.utils module
----------------------------
.. automodule:: pypushflow.test.utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: pypushflow.test
:members:
:undoc-members:
:show-inheritance:
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment