Skip to content
Permalink
Browse files

updated docs

  • Loading branch information...
Nirmal-Neel committed May 14, 2019
1 parent 5bf5279 commit ebac8b9a4d1ec1309997763a6ccbfd5963ff1655
@@ -0,0 +1,7 @@
PMML44 module
=============

.. automodule:: PMML44
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,7 @@
PMML44Super module
==================

.. automodule:: PMML44Super
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,7 @@
arima module
============

.. automodule:: arima
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,198 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Nyoka documentation build configuration file, created by
# sphinx-quickstart on Tue May 14 16:41:58 2019.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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('.'))
import os
import sys
sys.path.append(os.path.join(os.curdir, "scripts"))


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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.viewcode',
'sphinx.ext.githubpages']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Nyoka'
copyright = '2018, maintainer@nyoka.org'
author = 'maintainer@nyoka.org'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '3.1.0'
# The full version, including alpha/beta/rc tags.
release = '3.1.0'

# 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 = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- 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'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# 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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
]
}


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Nyokadoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Nyoka.tex', 'Nyoka Documentation',
'maintainer@nyoka.org', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'nyoka', 'Nyoka Documentation',
[author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Nyoka', 'Nyoka Documentation',
author, 'Nyoka', 'One line description of project.',
'Miscellaneous'),
]



# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


@@ -0,0 +1,7 @@
exponential\_smoothing module
=============================

.. automodule:: exponential_smoothing
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,16 @@
scripts
=======

.. toctree::
:maxdepth: 4

PMML44
PMML44Super
arima
exponential_smoothing
keras_model_to_pmml
lgb_to_pmml
metadata
pre_process
skl_to_pmml
xgboost_to_pmml
@@ -0,0 +1,7 @@
keras\_model\_to\_pmml module
=============================

.. automodule:: keras_model_to_pmml
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,7 @@
lgb\_to\_pmml module
====================

.. automodule:: lgb_to_pmml
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,7 @@
metadata module
===============

.. automodule:: metadata
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,16 @@
scripts
=======

.. toctree::
:maxdepth: 4

PMML44
PMML44Super
arima
exponential_smoothing
keras_model_to_pmml
lgb_to_pmml
metadata
pre_process
skl_to_pmml
xgboost_to_pmml
@@ -0,0 +1,7 @@
pre\_process module
===================

.. automodule:: pre_process
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,7 @@
skl\_to\_pmml module
====================

.. automodule:: skl_to_pmml
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,7 @@
xgboost\_to\_pmml module
========================

.. automodule:: xgboost_to_pmml
:members:
:undoc-members:
:show-inheritance:
@@ -0,0 +1,3 @@
python:
version: 3
setup_py_install: true

0 comments on commit ebac8b9

Please sign in to comment.
You can’t perform that action at this time.