Add documentation template (keon#314)

keon · web-flow · commit 4c93de3eedc0 · 2018-06-06T03:05:47.000-04:00
* add docs template

* add logo

* create documentation template
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,5 @@ __pycache__/
 # Python egg metadata, regenerated from source files by setuptools.
 /*.egg-info
 /*.egg
+# docs
+build/
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+<p align="center"><img width="40%" src="docs/source/_static/algorithms_logo.png" /></p>
+
 English | [简体中文](README_CN.md) | [Deutsch](README_GE.md) | [日本語](README_JP.md) | [한국어](README_KR.md)
 
 [![Open Source Helpers](https://www.codetriage.com/keon/algorithms/badges/users.svg)](https://www.codetriage.com/keon/algorithms)
diff --git a/algorithms/__init__.py b/algorithms/__init__.py
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = algorithms
+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)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=algorithms
+
+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%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,21 @@
+# Progress bars on iterators
+tqdm
+sphinx_rtd_theme
+
+# Downloading data and other files
+requests
+
+# Required for tests only:
+
+# Style-checking for PEP8
+flake8
+
+# Run unit tests
+pytest
+
+# Lets pytest find our code by automatically modifying PYTHONPATH
+pytest-pythonpath
+
+# Coverage statistics
+pytest-cov
+codecov
diff --git a/docs/source/_static/algorithms_logo.png b/docs/source/_static/algorithms_logo.png
diff --git a/docs/source/arrays.rst b/docs/source/arrays.rst
@@ -0,0 +1,16 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.arrays
+=================
+
+.. automodule:: algorithms.arrays
+.. currentmodule:: algorithms.arrays
+
+longest_non_repeat
+------------------
+
+:hidden:`longest_non_repeat_v1`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: longest_non_repeat_v1
diff --git a/docs/source/backtrack.rst b/docs/source/backtrack.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.backtrack
+====================
diff --git a/docs/source/bfs.rst b/docs/source/bfs.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.bfs
+=================
diff --git a/docs/source/bit.rst b/docs/source/bit.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.bit
+=================
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,177 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# algorithms documentation build configuration file, created by
+# sphinx-quickstart on Wed Jun  6 01:17:26 2018.
+#
+# 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('.'))
+from recommonmark.parser import CommonMarkParser
+
+# -- 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.mathjax',
+    'sphinx.ext.ifconfig',
+    '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_parsers = {
+    '.md': CommonMarkParser
+}
+source_suffix = ['.rst', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'algorithms'
+copyright = '2018, Algorithms Team & Contributors'
+author = 'Algorithms Team & Contributors'
+
+# 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 = '0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.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 = []
+
+# 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']
+
+# 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',
+        'searchbox.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'algorithmsdoc'
+
+
+# -- 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, 'algorithms.tex', 'algorithms Documentation',
+     'Algorithms Team \\& Contributors', '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, 'algorithms', 'algorithms 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, 'algorithms', 'algorithms Documentation',
+     author, 'algorithms', 'One line description of project.',
+     'Miscellaneous'),
+]
diff --git a/docs/source/dfs.rst b/docs/source/dfs.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.dfs
+=================
diff --git a/docs/source/dp.rst b/docs/source/dp.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.dp
+=================
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+Examples
+=================
diff --git a/docs/source/graph.rst b/docs/source/graph.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.graph
+=================
diff --git a/docs/source/heap.rst b/docs/source/heap.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.heap
+=================
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,38 @@
+.. image:: /_static/algorithms_logo.png
+   :target: https://github.com/keon/algorithms
+   :scale: 50 %
+
+The :mod:`algorithms` package consists of
+minimal and clean example implementations of data structures and algorithms.
+
+.. toctree::
+   :maxdepth: 2
+   :caption:  Package Reference
+
+   self
+   algorithms.arrays <arrays>
+   algorithms.backtrack <backtrack>
+   algorithms.bfs <bfs>
+   algorithms.bit <bit>
+   algorithms.dfs <dfs>
+   algorithms.dp <dp>
+   algorithms.graph <graph>
+   algorithms.heap <heap>
+   algorithms.linkedlist <linkedlist>
+   algorithms.map <map>
+   algorithms.maths <maths>
+   algorithms.matrix <matrix>
+   algorithms.queues <queues>
+   algorithms.search <search>
+   algorithms.set <set>
+   algorithms.sort <sort>
+   algorithms.stack <stack>
+   algorithms.strings <strings>
+   algorithms.tree <tree>
+   examples
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
diff --git a/docs/source/linkedlist.rst b/docs/source/linkedlist.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.linkedlist
+=====================
diff --git a/docs/source/map.rst b/docs/source/map.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.map
+=================
diff --git a/docs/source/maths.rst b/docs/source/maths.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.maths
+=================
diff --git a/docs/source/matrix.rst b/docs/source/matrix.rst
@@ -0,0 +1,5 @@
+.. role:: hidden
+    :class: hidden-section
+
+algorithms.matrix
+=================
diff --git a/docs/source/queues.rst b/docs/source/queues.rst
diff --git a/docs/source/search.rst b/docs/source/search.rst
diff --git a/docs/source/set.rst b/docs/source/set.rst
diff --git a/docs/source/sort.rst b/docs/source/sort.rst
diff --git a/docs/source/stack.rst b/docs/source/stack.rst
diff --git a/docs/source/strings.rst b/docs/source/strings.rst
diff --git a/docs/source/tree.rst b/docs/source/tree.rst
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<p align="center"><img width="40%" src="docs/source/_static/algorithms_logo.png" /></p>`
	`2`	`+`
`1`	`3`	`English \| [简体中文](README_CN.md) \| [Deutsch](README_GE.md) \| [日本語](README_JP.md) \| [한국어](README_KR.md)`
`2`	`4`
`3`	`5`	`[![Open Source Helpers](https://www.codetriage.com/keon/algorithms/badges/users.svg)](https://www.codetriage.com/keon/algorithms)`