Skip to content

Commit 8d08be6

Browse files
Kun-Lung WuGitHub Enterprise
Kun-Lung Wu
authored and
GitHub Enterprise
committed
Merge pull request #54 from codeflare/docs
Docs
2 parents 90b01a9 + 5077e2d commit 8d08be6

File tree

10 files changed

+578
-28
lines changed

10 files changed

+578
-28
lines changed

‎codeflare/pipelines/Datamodel.py‎

Lines changed: 341 additions & 28 deletions
Large diffs are not rendered by default.

‎codeflare_pipelines.egg-info/SOURCES.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ codeflare/pipelines/Datamodel.py
55
codeflare/pipelines/Exceptions.py
66
codeflare/pipelines/Runtime.py
77
codeflare/pipelines/__init__.py
8+
codeflare/pipelines/test_Datamodel.py
89
codeflare_pipelines.egg-info/PKG-INFO
910
codeflare_pipelines.egg-info/SOURCES.txt
1011
codeflare_pipelines.egg-info/dependency_links.txt

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/codeflare.pipelines.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
codeflare.pipelines package
2+
===========================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
codeflare.pipelines.tests
11+
12+
Submodules
13+
----------
14+
15+
codeflare.pipelines.Datamodel module
16+
------------------------------------
17+
18+
.. automodule:: codeflare.pipelines.Datamodel
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
codeflare.pipelines.Exceptions module
24+
-------------------------------------
25+
26+
.. automodule:: codeflare.pipelines.Exceptions
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
codeflare.pipelines.Runtime module
32+
----------------------------------
33+
34+
.. automodule:: codeflare.pipelines.Runtime
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
codeflare.pipelines.test\_Datamodel module
40+
------------------------------------------
41+
42+
.. automodule:: codeflare.pipelines.test_Datamodel
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: codeflare.pipelines
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎docs/source/codeflare.pipelines.tests.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
codeflare.pipelines.tests package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
codeflare.pipelines.tests.test\_save\_load module
8+
-------------------------------------------------
9+
10+
.. automodule:: codeflare.pipelines.tests.test_save_load
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: codeflare.pipelines.tests
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/codeflare.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
codeflare package
2+
=================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
codeflare.pipelines
11+
12+
Module contents
13+
---------------
14+
15+
.. automodule:: codeflare
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

‎docs/source/conf.py‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'CodeFlare Pipelines'
21+
copyright = '2021, Mudhakar Srivatsa, Raghu Ganti, Carlos Costa'
22+
author = 'Mudhakar Srivatsa, Raghu Ganti, Carlos Costa'
23+
24+
# The full version, including alpha/beta/rc tags
25+
release = '1.0.0'
26+
27+
28+
# -- General configuration ---------------------------------------------------
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc', 'numpydoc', 'sphinx.ext.autosummary'
34+
]
35+
36+
# Add any paths that contain templates here, relative to this directory.
37+
templates_path = ['_templates']
38+
39+
# List of patterns, relative to source directory, that match files and
40+
# directories to ignore when looking for source files.
41+
# This pattern also affects html_static_path and html_extra_path.
42+
exclude_patterns = ['*tests*', '*test*']
43+
44+
numpydoc_show_class_members = True
45+
46+
class_members_toctree = False
47+
48+
pygments_style = 'sphinx'
49+
50+
autodoc_mock_imports = ['codeflare.pipelines.tests']
51+
52+
# -- Options for HTML output -------------------------------------------------
53+
54+
# The theme to use for HTML and HTML Help pages. See the documentation for
55+
# a list of builtin themes.
56+
#
57+
html_theme = 'sphinx_rtd_theme'
58+
59+
# Add any paths that contain custom static files (such as style sheets) here,
60+
# relative to this directory. They are copied after the builtin static files,
61+
# so a file named "default.css" will overwrite the builtin "default.css".
62+
html_static_path = ['_static']

‎docs/source/index.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. CodeFlare Pipelines documentation master file, created by
2+
sphinx-quickstart on Sun May 30 20:17:42 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to CodeFlare Pipelines's documentation!
7+
===============================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

‎docs/source/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
codeflare
2+
=========
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
codeflare

0 commit comments

Comments
 (0)