From 30f1f8a36d96410c994e466a7b8f2aa517df4c48 Mon Sep 17 00:00:00 2001 From: Tim Paine Date: Wed, 21 Feb 2018 18:29:54 -0500 Subject: [PATCH] . --- .gitignore | 2 + docs/Makefile | 20 +++++ docs/conf.py | 170 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 65 ++++++++++++++++ docs/installation.rst | 38 ++++++++++ docs/make.bat | 36 +++++++++ docs/quickstart.rst | 7 ++ 7 files changed, 338 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/installation.rst create mode 100644 docs/make.bat create mode 100644 docs/quickstart.rst diff --git a/.gitignore b/.gitignore index 7bbc71c..4f61b8c 100644 --- a/.gitignore +++ b/.gitignore @@ -99,3 +99,5 @@ ENV/ # mypy .mypy_cache/ + +.DS_Store diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..c14dfd2 --- /dev/null +++ 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 = pyEX +SOURCEDIR = . +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) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..42ca285 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,170 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# pyEX documentation build configuration file, created by +# sphinx-quickstart on Fri Jan 12 22:07:11 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('.')) +import sphinx_rtd_theme + + +# -- 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.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 = 'pyEX' +copyright = '2018, Tim Paine' +author = 'Tim Paine' + +# 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 = 'v0.0.16' +# The full version, including alpha/beta/rc tags. +release = 'v0.0.16' + +# 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 = 'alabaster' +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# 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 = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pyEXdoc' + + +# -- 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, 'pyEX.tex', 'pyEX Documentation', + 'Tim Paine', '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, 'pyEX', 'pyEX 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, 'pyEX', 'pyEX Documentation', + author, 'pyEX', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..f6150a0 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,65 @@ +.. pyEX documentation master file, created by + sphinx-quickstart on Fri Jan 12 22:07:11 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +pyEX +=================================== +Python interface to IEX Api (https://iextrading.com/developer/docs/) + + +|build-status| |issues| |waffle| |codecov| |gitter| |bch| |pypiv| |pypil| |docs| + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + installation + quickstart + + +.. |build-status| image:: https://travis-ci.org/timkpaine/pyEX.svg?branch=master + :alt: Build Status + :scale: 100% + :target: https://travis-ci.org/timkpaine/pyEX + +.. |issues| image:: https://img.shields.io/github/issues/timkpaine/pyEX.svg + :alt: Issues + :scale: 100% + :target: https://img.shields.io/github/issues/timkpaine/pyEX.svg + +.. |waffle| image:: https://badge.waffle.io/timkpaine/pyEX.svg?label=ready&title=Ready + :alt: Waffle + :scale: 100% + :target: http://waffle.io/timkpaine/pyEX + +.. |codecov| image:: https://codecov.io/gh/timkpaine/pyEX/branch/master/graph/badge.svg + :alt: Codecov + :scale: 100% + :target: https://codecov.io/gh/timkpaine/pyEX + +.. |gitter| image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg + :alt: Gitter + :scale: 100% + :target: https://gitter.im/knowledge_lab/Lobby + +.. |bch| image:: https://bettercodehub.com/edge/badge/timkpaine/pyEX?branch=master + :alt: BCH + :scale: 100% + :target: https://bettercodehub.com/ + +.. |pypiv| image:: https://img.shields.io/pypi/v/pyEX.svg + :alt: Version + :scale: 100% + :target: https://pypi.python.org/pypi/pyEX + +.. |pypil| image:: https://img.shields.io/pypi/l/pyEX.svg + :alt: License + :scale: 100% + :target: https://pypi.python.org/pypi/pyEX + +.. |docs| image:: https://img.shields.io/readthedocs/pyEX.svg + :alt: Docs + :scale: 100% + :target: http://pyEX.readthedocs.io/en/latest/ diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..8a7b566 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,38 @@ +============ +Installation +============ + +From Pip +============ + +.. code:: bash + + pip install knowledgelab + +From Source +============ + +.. code:: bash + + python setup.py install + +or + +.. code:: bash + + make install + + +Jupyter Extensions +================== +To install the server extensions: + +.. code:: bash + + jupyter serverextension enable --py knowledgelab + +To install the JupyterLab extensions: + +.. code:: bash + + jupyter labextension install knowledgelab diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..aacb300 --- /dev/null +++ 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=. +set BUILDDIR=_build +set SPHINXPROJ=pyEX + +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/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 0000000..7efffee --- /dev/null +++ b/docs/quickstart.rst @@ -0,0 +1,7 @@ +=============== +Getting started +=============== +.. WARNING:: KnowledgeLab is under active beta development, so interfaces and functionality may change + +Overview +===============