Skip to content

Commit

Permalink
Added sphinx-based documentation (drafts)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsblank committed Aug 6, 2017
1 parent 7dc5584 commit aad6a67
Show file tree
Hide file tree
Showing 6 changed files with 260 additions and 14 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 = python3 -msphinx
SPHINXPROJ = conx
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)
161 changes: 161 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# conx documentation build configuration file, created by
# sphinx-quickstart on Sun Aug 6 11:05:16 2017.
#
# 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('.'))


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

# 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 = 'conx'
copyright = '2017, Douglas Blank'
author = 'Douglas Blank'

# 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.0'
# The full version, including alpha/beta/rc tags.
release = '3.0.1'

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

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


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

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


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

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


# -- 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, 'conx.tex', 'conx Documentation',
'Douglas Blank', '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, 'conx', 'conx 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, 'conx', 'conx Documentation',
author, 'conx', 'One line description of project.',
'Miscellaneous'),
]



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

Submodules
----------

conx\.layers module
-------------------

.. automodule:: conx.layers
:members:
:undoc-members:
:show-inheritance:

conx\.network module
--------------------

.. automodule:: conx.network
:members:
:undoc-members:
:show-inheritance:

conx\.utils module
------------------

.. automodule:: conx.utils
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: conx
:members:
:undoc-members:
:show-inheritance:
20 changes: 20 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. conx documentation master file, created by
sphinx-quickstart on Sun Aug 6 11:05:16 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to conx's documentation!
================================

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



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 @@
conx
====

.. toctree::
:maxdepth: 4

conx
28 changes: 14 additions & 14 deletions notebooks/CIFAR10 CNN.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
"data": {
"image/png": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAIAAAD/gAIDAAAPc0lEQVR4nO1dWY/cyJFOkkkWWXdV\nd1ffUlvSSCsPRhqfGMjew/CL/WLs2/679R9YGIaxWGCBNWwY2PHDejDG2jMeyxpppL7UVxW7ikUW\n733I70sWjAUsvjNeFGAlo7JS8WVERkRGG9/7h38UQgghfH+qmJZZKGbslIJ0Z6OtmK1xRzGbw65i\nHMtWjGx5GG1J9e905ismySBqNBxomWaeKiaOY8WsVivFuJ6rmFzkigmjQDGDYR/vl7kWlcQJvllg\nMpZlKabXxTw7HczctiE84lulYWpRwpR/JTMrDXwiGnpnaharBsnPPv9Mcf71tWLGUFJhbLh63Gbe\nw0NvophlAdgGOSBWGo5iwhUUOIyArzQHtK8tQ8t0JV7MMnxqEQKtVouilhhTQKax2lCMaVU/IyWQ\nPYk5BwTRNM8U024DhoYJqBrcQIRZKU24wuaQpWAsick0mlWDmsWqQdKTxAV0Tdwl+o62K8s12Ror\nxtPKbODFKIYJW6XAQsmPHI/2kdawLGItczCGhc1SfOrYGJ/T0FkOphUn+JY0g/A2PxJCyA5edPkw\nM4BfswTGM4EX9U7Q7WACwTLUotIM6DM5bDG/xRPR0DtTs1g1SLoGjEWvB0v0cH+kmA2vsjd2ARQE\nU1iZvMBCRyEkmDCGok9/VRIU/u0CT2T13eMeULCYAzIJbV9Ek1QSO126lGkS4evySpZN65nT0ZUE\nWxzjiWNjfmaBCcfBDO/nlfvd4o/OCuD3domto9GsGtQsVg1qFqsGyVELyPcI+wHN8Fbf1uPyAsZc\nH14tSXDT/Y0L7hfcmSTNdh5joymt6r/n8tLHpymkLkKY8DDHztj1eGyOMcYSkGka1UZjtXg2XmJv\nbdt9zgHDVjxXRCn2rELgIz9YaVF+iF8RcC9epZhzo1k1qFmsGiS3hlDgng1YuS4Y06r03KMvnmaA\nQ0GjXpZQbx20yhNoclHSAyCsSkn/QohFAkchz/GNIc/bGZnFEhJOpxhsM9zWD6ozefoWUYDoFkC+\ns/lAMZPJgWKMHhzxeHajmCCAzNtFBcPrW+wYXx1jfM7wXKNZNahZrBok97bgGfcdbP7dNpBiEERC\nCEHDYdDAxREU3iQeN3o4eHc6gPb8FugY9GGbFqtK5utTfBrEgKED2WK/TXtqExQ3Pr63xGB7zRoO\n+gi3Pfv6t/HV59guyhDDBpsw7nEI4UEAXWnZld0/3IGoyWRbMRfzFX9pQ+9MzWLVIDnuwczJxFdM\ny4aWtlttPS6OAJ+Up9DhEOftkl5fkmPp05SeITMrZ1c4i375+lbLvFpAFL0/cZdH93/++w8Vc7AL\nCf/2yUvF/PbFW8XoQLMQQpqYw8K/gswA39jrEWI5tgvXxROHdr9tVDDMGIa+c7gHCVNEARrNqkHN\nYtUgORkjWRJNuecbNBZhZbmiBMopDTqQPNDp9Y5S4GI4gu1LGCd6eXKmmOm8yoxqB9XigbHv4tOJ\nhOa7U6Dpvf6OYs7HGHzhX2pRcYiv/vT5c8yKGaO0w9PlANZNp1EHA+wzvaIyrCt61GUyV8wRHYZG\ns2pQs1g1SI42txQ36sIsmsxB+vOZHpcuUWpg5vpsCD0vaT27XfiiqQDzp5cAxTLGKcx1q5SM6zA6\nxCzLyALYP3lxoZgswZh4ABhujSDcEMSXEGmGPSRk0HlJXzTJINPgLkEnWthM4JRrCVub8aWMiduS\nm0mjWTWoWawaJIVO/K+djxS13OpJW3T0C4oxGSBNiceWh7Ph9VvYsvAaQL7HAoq4ioUIl+h7dH8f\nMvlxxiqEObcCacGb7TmYycbovhZ1/707inn15n8U88XzU8U4kmgqsZNkGUMuNMe2U/3SgkkdHYMy\njCZSWp+axapBUqczjTTiQ5iP5XKuxyUM2mcma3pCYG1OZv8Q6l1meHJ3E5p8fw96Hq6q8Ob+w6eK\ncUqgb3aLyXhDuMriBnbqcGdXMf4ShvXe372nRfVHbTKPIepqQZnAr038miUscsosDJEnhBA50xm6\n1kEffhvNqkHNYtUgmRuMKDI0obXOcz09rsu6hLMroPXVCYIh0mbB0AUOgKsLfPTeBOj74T8BMl+e\nTrXM3j784c0NOJyXV/BFh0NCpmA4hX7j5RXMnHR9LerKP1fM6TlMnm1jwsM+MBZFLHuSUBGDSCuK\n6sRqsl7KoLnXhRCNZtWgZrFqULNYNUgOWUuVSexZARP/ZVoh+XYBA/z6zQWHYXfwXKz4+Su4Gtsu\nPOP9/buKGe59TTH2Ys1K84Rw8PS7ePAW+5GXYdfLBSazZBHDbhs7XZJXoowOfsVBh7HgIfbBxQ3C\n0JcXyK2mDCKvEtZsmlU8q8OyiYTXFLR/32hWDWoWqwbJhQ/llAlcXltfZFmrype8ChMGwOOoB+s+\nZEo1mgGGkz343/tPcDHojyeIJT1/UaVknu2iAtr38XD7Pnx6UyCDm8TA45DJ3fklJuwlVdR7d0xR\nObxz+wmSTxG9iv/+j18o5uQYMq3q/FydK+hgiFSHDHh7oNGsGtQsVg3SRb0i5+avC4RNnqiFEDmT\nOjPq/nxOh5i3ZHYHAOZ3fvADxRw8+kgxP/vpvypmh2ZLCGExBHz68kt8eu/rinE3UDDUKRkamyKX\n4xXAVxJVlf7XC/DDLZjdjZ0jxUQBos8mo9C5A8OqPfg0rTYHgzVVBq/oVfEv0dA7U7NYNUjqup2c\ne74+QMq1lSxZ62DQExzzbutOG2j95rcfKubxM6BvdglotzLY0HsHB1pmQVk7E/iZ2YrVD76uJsST\nNAIWcgEgf3l6okX94Y+/U8yzj/Dixg4s8nwB/PJkLTaPsF0U+qicVO53xl3l9spXTLzAm41m1aBm\nsWqQLLj5RzFA4dBgSVnlPCwTyvlgB8bI9bDQR3cPFfP0+zCCu4+eKOb3v/2pYu4c4q2d9z/QMp0t\npGdkG2mhcAXYRnMYwYuzY8XMLgC6PIXh83prF21Z1Xd89qlitneRMcpCWnleqzWWyBjlJavz14oI\nvRYjaDvMMLWaC+X1qVmsGiRtFnnP6NflTMB47SqsbDGIMaERPD73FXP/mz9SzMEHP+JwgC5dIBMz\nYG3u1sMPtcylxIHus0+RGY0jjJ/PIfz69A0mwEp618WE97+2r0U9eQgnNrPYvMEagnF4SYZNI8LX\nCATpLShb05mAp+D2BkRt86jbaFYNaharBsk4YrEsr4cZLEu1zepsqHM/Xhef/uRffqKYZz/+oWL6\nmywcf/knxViU4DPQevXVn7XMswVQ8Ouf/1wxXY8xzBgmbIeX2vuMCL06gX1M1qY33jtSzMMPvoVH\njNVMfZhRnd+dRSxCKvGTV1EVdA2Y3CoZMX48xEeNZtWgZrFqkCx4p0sw0WiwdDVbu45i0G1zW4h0\nfPgtKLy+y/H57+EQzs4QcolZQrSYIbd6/OJzLTMoYW3tHMO6vPDZdwG6rRFgeH7B8neeYcNFoEUd\nv3pDFt1igoAlvLqJSwuNYW4y/ASPvZTavcrue2ymsggR+M1Y+t9oVg1qFqsGNYtVg6RgkWORYfOS\nDPzkWRXlSRhi3h7AO//PX/y7Ysbb2CYmuzhRJyFLomzgv8vKfblWF9zhZrcz4cWFBY64noUXb65w\nzS5lyKnHcpUkqPasv3yKeNb5F6iPjjOWm/GGbs6v7hx0OAP8ZLNVVW+63KFGAl/0+H2EqhvNqkHN\nYtUgWRRs30Sz7Uq6s2aVeix5QC2Y2ry+hi0PrsB4KWxtwfTseAR8DfcYOM6rllCnZ3ix5DVZUzcn\nZDTZYl1Cx2X/KM7OytbKJujZ5AnbN/F3zUNAO2kBmL09zGHp+YpZrN3GWy2hQBv9e4rZnDQH6frU\nLFYNkqYBu+Oyy2hJw9fxqpusnd6mYkLeUt3ooa5Icnxyi2qkgs2hQhtI2d6GQSmSSuEfPUGm5+Nf\n/RISSsTUbN32LcCTfg/21OHdGstYO/0yVvXqHKDzffZ9You2rYfQjP0h7WmJec6uq3ytsyLw92mj\nw7++LNjQ36ZmsWqQdJhKDXljzOIhtrCq624hrxRYrE1uOTwG2xjvMEkz6OPJW1Yfh/tA3OTwgZZ5\negmH8/3vfE8xwRXqnV8+h6O7DHxM1MIEBgPg0RAVDM9P8eIbXlg3W+xXsa0bHfNFYtaYYsxoVjV5\n258g2H0wxJxffA6r3WhWDWoWqwbJ7S3ehLtBRV3EwlZekhFCiNKERdCNxPp9GAuHR7yId3083m0V\nvIf6u48/Vsy9Rxda5skJ1Zveb5sJTos7gOcBKcsAMIwiMFlWGdauh/HPvoF6C5fWM+PtWJ2djY55\ndX6BeNak3dOivvHwfTwcIkr+yfkrjBcNvTM1i1WD5J1DOGYDAzr54hjqenFVVQAkTJZ0u0DWknGY\nvECoxOLST6+A6EWg2+ZhsFVW7VV6XUR7Lt4i6HzCYveC/eq3twB2gw0FZz7czlanMtbDAXDksEVE\nrKuIWLGxjPFREtDtZKvVB4c7WtQea5WOT7Bj3Fzpfk4NvTM1i1WDZH9EW0ZlG00YzOxUZ8PrC/6Z\nCR7upMMeKjo9xOsrKeMwtxEg06G1WoVVTDJawSlN+KLuwVmyo1gw59mw75GB6xutF+De4Iu6Xd0h\nn/fk2InQkZDA+ybCcfAtRw+OqlmxIcRvfoNE1P8+R+1go1k1qFmsGiQlK3jcPsziuMsC3KiKatoe\nb4PoYxRbi3kukpc5AzJ57CvGYes+u2potNbAjDdMEpahlzSCuhKvZM985mGFresR15rn+zPAMGIg\nV//FGUk86i4OIWNKF9e8dB5UZROLJez1f/36Cwwj3BvNqkHNYtWgZrFqkAzozgoLRcrdDrYH2/t/\n7ncOBthognlEhndbGX5NV0yIOvCGXR62dZ8lIYRkKM3hf5nNNv+6/UubBwbmfaoGho5XBaH6Q2yF\nUzYzXHBD7LP1XMiD91++wgHjiz+g1GuboS4hxPYBd1X2Jd7k8aDRrBrULFYNkievwcU+23dvQc9d\nr6rPGvDm23jM9on8WzW+D2Z2w2QJ1FxYBWBVsPYwz6v6CV0Rpv/H9J02i1GziA5KSeNu80SdhVU/\njZzefE7HwmdaSB+op9w3vnqB+fk3/EMjy2pWO2wB9/guqqH5XqNZdahZrBokcxvZ09RBv+uYf6HK\nzK71OHcAgAy3gNYRi4XHIayGP8VJ1b8G+qIl771l7JlfVv89BYsVVqyYdhw6+iy8WKzYSYa1wzbr\nOntmFQsuTES005R/x67Duk6WPQ0dvHhPDBXzwVOcuh89eapFHT1A/um7HwHIJ2dsDikaemdqFqsG\n/R+Z1dd5hPzx7AAAAABJRU5ErkJggg==\n",
"text/plain": [
"<PIL.Image.Image image mode=RGB size=100x100 at 0x7F7CBBFED358>"
"<PIL.Image.Image image mode=RGB size=100x100 at 0x7F93437E2400>"
]
},
"execution_count": 7,
Expand Down Expand Up @@ -179,7 +179,7 @@
},
{
"cell_type": "code",
"execution_count": 15,
"execution_count": 9,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -208,7 +208,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "da7825ca78c54419863cc3486eede0ce"
"model_id": "d50d81fb826741b8ae32f0be10592fe6"
}
},
"metadata": {},
Expand Down Expand Up @@ -241,16 +241,16 @@
{
"data": {
"text/plain": [
"[0.088960625,\n",
" 0.10170238,\n",
" 0.10176115,\n",
" 0.11131479,\n",
" 0.096437737,\n",
" 0.10276172,\n",
" 0.10323853,\n",
" 0.098630145,\n",
" 0.091990814,\n",
" 0.10320213]"
"[0.11418207,\n",
" 0.096262164,\n",
" 0.10081588,\n",
" 0.102906,\n",
" 0.095634915,\n",
" 0.086578459,\n",
" 0.10232524,\n",
" 0.092678986,\n",
" 0.11052275,\n",
" 0.098093539]"
]
},
"execution_count": 11,
Expand Down Expand Up @@ -282,7 +282,7 @@
},
{
"cell_type": "code",
"execution_count": 13,
"execution_count": 12,
"metadata": {},
"outputs": [
{
Expand Down

0 comments on commit aad6a67

Please sign in to comment.