diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000000..78121329bb --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +_venv +_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000..541c08d37b --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,28 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +VENVDIR = _venv +BINDIR = $(VENVDIR)/bin +SPHINXBUILD = $(BINDIR)/sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: $(SPHINXBUILD) + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +$(SPHINXBUILD): $(VENVDIR) + $(VENVDIR)/bin/pip install -r requirements.txt + +$(VENVDIR): + python3 -m venv $(VENVDIR) + +.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/conf.py b/docs/conf.py new file mode 100644 index 0000000000..b93b432911 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,55 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- 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('.')) +import sphinx_rtd_theme + +# -- Project information ----------------------------------------------------- + +project = 'sqlc' +copyright = '2021, Kyle Conroy' +author = 'Kyle Conroy' + +# The full version, including alpha/beta/rc tags +release = '1.6.0' + + +# -- General configuration --------------------------------------------------- + +# 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_rtd_theme', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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 = ['_build', '_venv', 'Thumbs.db', '.DS_Store'] + +# -- 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' + +# 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'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..54e5ffe190 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. sqlc documentation master file, created by + sphinx-quickstart on Mon Feb 1 23:18:36 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to sqlc's documentation! +================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..d795416b50 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,24 @@ +alabaster==0.7.12 +Babel==2.9.0 +certifi==2020.12.5 +chardet==4.0.0 +docutils==0.16 +idna==2.10 +imagesize==1.2.0 +Jinja2==2.11.3 +MarkupSafe==1.1.1 +packaging==20.9 +Pygments==2.7.4 +pyparsing==2.4.7 +pytz==2021.1 +requests==2.25.1 +snowballstemmer==2.1.0 +Sphinx==3.4.3 +sphinx-rtd-theme==0.5.1 +sphinxcontrib-applehelp==1.0.2 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==1.0.3 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-serializinghtml==1.1.4 +urllib3==1.26.3