Merge pull request #33 from stanislaw/develop

docs: initial skeleton

docs/.gitignore

@@ -0,0 +1,2 @@
+_build
+

docs/01-what-is-filecheck.rst

@@ -0,0 +1,7 @@
+What is FileCheck
+=================
+
+...
+
+
+

docs/02-installation.rst

@@ -0,0 +1,7 @@
+Installation
+============
+
+...
+
+
+

docs/03-tutorial-hello-world.rst

@@ -0,0 +1,6 @@
+Tutorial: Hello World
+=====================
+
+...
+
+

docs/04-check-commands.rst

@@ -0,0 +1,22 @@
+Check commands
+==============
+
+CHECK
+-----
+
+...
+
+CHECK-NOT
+---------
+
+...
+
+CHECK-NEXT
+----------
+
+...
+
+CHECK-EMPTY
+-----------
+
+...

docs/Makefile

@@ -0,0 +1,21 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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)
+

docs/conf.py

@@ -0,0 +1,67 @@
+# 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 guzzle_sphinx_theme
+
+# -- Project information -----------------------------------------------------
+
+project = 'FileCheck.py'
+copyright = '2019, Stanislav Pankevich'
+author = 'Stanislav Pankevich'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- 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 = [
+]
+
+# 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', '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_path = guzzle_sphinx_theme.html_theme_path()
+extensions.append("guzzle_sphinx_theme")
+html_theme = 'guzzle_sphinx_theme'
+
+# html_theme = 'pyramid'
+
+html_theme_options = {
+    "project_nav_name": "Mull",
+}
+html_sidebars = { '**': ['globaltoc.html', 'searchbox.html'] }
+
+# 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']
+master_doc = 'index'
+

docs/index.rst

@@ -0,0 +1,16 @@
+Welcome to FileCheck.py's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+
+   01-what-is-filecheck
+   02-installation
+   03-tutorial-hello-world
+   04-check-commands
+
+.. Indices and tables
+   ==================
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`