Skip to content

Commit

Permalink
'FN'
Browse files Browse the repository at this point in the history
  • Loading branch information
Denzel4 committed Sep 17, 2020
0 parents commit be76f83
Show file tree
Hide file tree
Showing 63 changed files with 779 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, 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)
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@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
7 changes: 7 additions & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
v1
==

.. toctree::
:maxdepth: 4

v1
56 changes: 56 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# 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 = 'GPU VM'
copyright = '2020, Liyokov'
author = 'Liyokov'

# The full version, including alpha/beta/rc tags
release = '1.0.0'


# -- 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'
]
napoleon_google_docstring=False

# 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 = []


# -- 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']
7 changes: 7 additions & 0 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
config module
=============

.. automodule:: config
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. GPU VM documentation master file, created by
sphinx-quickstart on Wed Sep 16 15:21:02 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to GPU VM's documentation!
==================================

.. toctree::
:maxdepth: 2
:caption: Contents:
modules
v1


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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 7 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
v1
==

.. toctree::
:maxdepth: 4

v1
117 changes: 117 additions & 0 deletions docs/source/v1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
v1 package
==========

Submodules
----------

v1.agent module
---------------

.. automodule:: v1.agent
:members:
:undoc-members:
:show-inheritance:

v1.annotation module
--------------------

.. automodule:: v1.annotation
:members:
:undoc-members:
:show-inheritance:

v1.attribute module
-------------------

.. automodule:: v1.attribute
:members:
:undoc-members:
:show-inheritance:

v1.auth module
--------------

.. automodule:: v1.auth
:members:
:undoc-members:
:show-inheritance:

v1.camera module
----------------

.. automodule:: v1.camera
:members:
:undoc-members:
:show-inheritance:

v1.category module
------------------

.. automodule:: v1.category
:members:
:undoc-members:
:show-inheritance:

v1.dataset module
-----------------

.. automodule:: v1.dataset
:members:
:undoc-members:
:show-inheritance:

v1.errors module
----------------

.. automodule:: v1.errors
:members:
:undoc-members:
:show-inheritance:

v1.image module
---------------

.. automodule:: v1.image
:members:
:undoc-members:
:show-inheritance:

v1.inference module
-------------------

.. automodule:: v1.inference
:members:
:undoc-members:
:show-inheritance:

v1.models module
----------------

.. automodule:: v1.models
:members:
:undoc-members:
:show-inheritance:

v1.monitoring module
--------------------

.. automodule:: v1.monitoring
:members:
:undoc-members:
:show-inheritance:

v1.user module
--------------

.. automodule:: v1.user
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: v1
:members:
:undoc-members:
:show-inheritance:
117 changes: 117 additions & 0 deletions docs/v1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
v1 package
==========

Submodules
----------

v1.agent module
---------------

.. automodule:: v1.agent
:members:
:undoc-members:
:show-inheritance:

v1.annotation module
--------------------

.. automodule:: v1.annotation
:members:
:undoc-members:
:show-inheritance:

v1.attribute module
-------------------

.. automodule:: v1.attribute
:members:
:undoc-members:
:show-inheritance:

v1.auth module
--------------

.. automodule:: v1.auth
:members:
:undoc-members:
:show-inheritance:

v1.camera module
----------------

.. automodule:: v1.camera
:members:
:undoc-members:
:show-inheritance:

v1.category module
------------------

.. automodule:: v1.category
:members:
:undoc-members:
:show-inheritance:

v1.dataset module
-----------------

.. automodule:: v1.dataset
:members:
:undoc-members:
:show-inheritance:

v1.errors module
----------------

.. automodule:: v1.errors
:members:
:undoc-members:
:show-inheritance:

v1.image module
---------------

.. automodule:: v1.image
:members:
:undoc-members:
:show-inheritance:

v1.inference module
-------------------

.. automodule:: v1.inference
:members:
:undoc-members:
:show-inheritance:

v1.models module
----------------

.. automodule:: v1.models
:members:
:undoc-members:
:show-inheritance:

v1.monitoring module
--------------------

.. automodule:: v1.monitoring
:members:
:undoc-members:
:show-inheritance:

v1.user module
--------------

.. automodule:: v1.user
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: v1
:members:
:undoc-members:
:show-inheritance:

0 comments on commit be76f83

Please sign in to comment.