Skip to content

Commit

Permalink
Sphinx documentation (#122)
Browse files Browse the repository at this point in the history
* Auto-generation documentation for python files.

* Code format corrections.

* Code format corrections.

* Delete source directory
  • Loading branch information
ce52supi authored Jun 9, 2021
1 parent 1a53518 commit 7d73dda
Show file tree
Hide file tree
Showing 152 changed files with 26,587 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = NeuralNetworkEnablement
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)
Binary file added docs/build/doctrees/acl_constants.doctree
Binary file not shown.
Binary file added docs/build/doctrees/colorize_process.doctree
Binary file not shown.
Binary file added docs/build/doctrees/data.doctree
Binary file not shown.
Binary file added docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/build/doctrees/license.doctree
Binary file not shown.
Binary file added docs/build/doctrees/model_process.doctree
Binary file not shown.
Binary file added docs/build/doctrees/modules.doctree
Binary file not shown.
Binary file added docs/build/doctrees/pipeline.doctree
Binary file not shown.
Binary file added docs/build/doctrees/readme.doctree
Binary file not shown.
Binary file added docs/build/doctrees/sample.doctree
Binary file not shown.
Binary file added docs/build/doctrees/tests.doctree
Binary file not shown.
Binary file added docs/build/doctrees/utils.doctree
Binary file not shown.
Binary file added docs/build/doctrees/videodata.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: fc9352cebb4e3bcc46a7b0c13f93c412
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/build/html/.nojekyll
Empty file.
7 changes: 7 additions & 0 deletions docs/build/html/_sources/acl_constants.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
acl\_constants module
=====================

.. automodule:: acl_constants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/build/html/_sources/colorize_process.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
colorize\_process module
========================

.. automodule:: colorize_process
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/build/html/_sources/data.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
data module
===========

.. automodule:: data
:members:
:undoc-members:
:show-inheritance:
46 changes: 46 additions & 0 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. Neural Network Enablement documentation master file, created by
sphinx-quickstart on Tue Jun 8 12:35:33 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Neural Network Enablement's documentation!
=====================================================


Image Colorization
--------------------

.. toctree::
:maxdepth: 2
:caption: Contents:


modules

Video Colorization
--------------------

.. toctree::
:maxdepth: 2
:caption: Contents:

videodata



Guide
------

.. toctree::
:maxdepth: 2

readme
license


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
3 changes: 3 additions & 0 deletions docs/build/html/_sources/license.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
License
*********
.. include:: ../../LICENSE
7 changes: 7 additions & 0 deletions docs/build/html/_sources/model_process.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
model\_process module
=====================

.. automodule:: model_process
:members:
:undoc-members:
:show-inheritance:
13 changes: 13 additions & 0 deletions docs/build/html/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
src
===

.. toctree::
:maxdepth: 4

acl_constants
colorize_process
model_process
pipeline
tests
utils

7 changes: 7 additions & 0 deletions docs/build/html/_sources/pipeline.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pipeline module
===============

.. automodule:: pipeline
:members:
:undoc-members:
:show-inheritance:
3 changes: 3 additions & 0 deletions docs/build/html/_sources/readme.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
README
*********
.. include:: ../../README.md
7 changes: 7 additions & 0 deletions docs/build/html/_sources/sample.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
sample module
=============

.. automodule:: sample
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/build/html/_sources/tests.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
tests module
============

.. automodule:: tests
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/build/html/_sources/utils.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
utils module
============

.. automodule:: utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/build/html/_sources/videodata.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
videodata module
================

.. automodule:: videodata
:members:
:undoc-members:
:show-inheritance:
Binary file added docs/build/html/_static/ajax-loader.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7d73dda

Please sign in to comment.