Merge pull request #1216 from common-workflow-language/rtd

enable basic docs

Author: mr-c

.readthedocs.yml

@@ -0,0 +1,21 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+   - method: pip
+     path: .
+     extra_requirements: [ docs ]

docs/Makefile

@@ -0,0 +1,20 @@
+# 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,60 @@
+# 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('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Common Workflow Language reference implementation'
+copyright = '2019, Peter Amstutz and contributors'
+author = 'Peter Amstutz and contributors'
+
+
+# -- 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.ext.autodoc",
+        "sphinx.ext.autosummary",
+        "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', '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']
+
+
+from pkg_resources import get_distribution
+release = get_distribution('cwltool').version
+version = '.'.join(release.split('.')[:2])

docs/cwltool.argparser.rst

@@ -0,0 +1,7 @@
+cwltool.argparser module
+========================
+
+.. automodule:: cwltool.argparser
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/cwltool.builder.rst

@@ -0,0 +1,7 @@
+cwltool.builder module
+======================
+
+.. automodule:: cwltool.builder
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/cwltool.checker.rst

@@ -0,0 +1,7 @@
+cwltool.checker module
+======================
+
+.. automodule:: cwltool.checker
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/cwltool.command_line_tool.rst

@@ -0,0 +1,7 @@
+cwltool.command\_line\_tool module
+==================================
+
+.. automodule:: cwltool.command_line_tool
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/cwltool.context.rst

@@ -0,0 +1,7 @@
+cwltool.context module
+======================
+
+.. automodule:: cwltool.context
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/cwltool.cwlrdf.rst

@@ -0,0 +1,7 @@
+cwltool.cwlrdf module
+=====================
+
+.. automodule:: cwltool.cwlrdf
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/cwltool.docker.rst

@@ -0,0 +1,7 @@
+cwltool.docker module
+=====================
+
+.. automodule:: cwltool.docker
+   :members:
+   :undoc-members:
+   :show-inheritance: