Add sphinx

Author: joar

Makefile

@@ -101,6 +101,14 @@ benchmark-full:
 docs:
 	make -C doc html
 
+.PHONY: docs-apidoc
+docs-apidoc:
+	sphinx-apidoc -o doc/source/api/ -H "API" rustcsv 'test_*'
+
+.PHONY: docs-autobuild
+docs-autobuild:
+	sphinx-autobuild -p 8001 doc/source/ doc/build/html/
+
 # Release management
 # ==================
 

Pipfile

@@ -15,6 +15,9 @@ isort = "*"
 colorlog = "*"
 pytest-benchmark = {version = "*", extras = ["histogram"]}
 hypothesis = "*"
+sphinx = "*"
+sphinx-autobuild = "*"
+sphinx-autodoc-typehints = "*"
 
 [requires]
 python_version = "3.6"

Pipfile.lock

@@ -5,9 +5,7 @@ fn main() {
     let src = std::env::var("CARGO_MANIFEST_DIR").unwrap();
     let dst = std::path::Path::new(&std::env::var("OUT_DIR").unwrap()).join("built.rs");
     let mut opts = built::Options::default();
-    opts.set_dependencies(true)
-        .set_compiler(true)
-        .set_env(true);
+    opts.set_dependencies(true).set_compiler(true).set_env(true);
     built::write_built_file_with_opts(&opts, src, dst)
         .expect("Failed to acquire build-time information");
 }

build.rs

@@ -0,0 +1 @@
+/build

doc/.gitignore

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = rust-csv-py
+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)

doc/Makefile

@@ -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=rust-csv-py
+
+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

doc/make.bat

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 -----------------------------------------------------
+from pkg_resources import get_distribution
+
+project = "rustcsv"
+copyright = "2018, Joar Wandborg"
+author = "Joar Wandborg"
+
+# The short X.Y version
+version = "0.1"
+
+# The full version, including alpha/beta/rc tags
+release = get_distribution("rustcsv").version
+
+
+# -- 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.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+]
+
+# 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"
+
+# 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 pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+
+# -- 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "rust-csv-pydoc"
+
+
+# -- 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,
+        "rust-csv-py.tex",
+        "rust-csv-py Documentation",
+        "Joar Wandborg",
+        "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, "rust-csv-py", "rust-csv-py 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,
+        "rust-csv-py",
+        "rust-csv-py Documentation",
+        author,
+        "rust-csv-py",
+        "One line description of project.",
+        "Miscellaneous",
+    )
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"https://docs.python.org/3": None}

doc/source/conf.py

@@ -0,0 +1,20 @@
+.. rust-csv-py documentation master file, created by
+   sphinx-quickstart on Mon Sep 10 13:34:57 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+rustcsv - rust-csv + PyO3
+=======================================
+
+.. toctree::
+    :maxdepth: 2
+
+    ./reader
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/index.rst

@@ -0,0 +1,26 @@
+=========
+CSVReader
+=========
+
+.. autoclass:: rustcsv.CSVReader
+
+    .. automethod:: __new__
+
+.. py:class:: rustcsv.CSVReader(path_or_file, delimiter=None, terminator=None)
+
+    Creates a new CSVReader instance
+
+    Arguments:
+
+    ``path_or_file`` (:class:`str` or :any:`binary file`)
+
+        -   A :class:`str` path to a file.
+        -   A :any:`binary file` object, 
+            e.g. :class:`io.BytesIO` or ``open(path, "rb")``.
+
+    ``delimiter`` (Optional :class:`bytes` of length 1)
+        The CSV field delimiter.
+        Defaults to ``b","`` if ``None``.
+    ``terminator`` (Optional :class:`bytes` of length 1)
+        The CSV record terminator.
+        Defaults to ``b"\n"`` if ``None``.