From 610f24fe54b25a1244c3e5cdf84c8aff12424f8f Mon Sep 17 00:00:00 2001 From: Greg Back Date: Tue, 14 Feb 2017 15:48:13 -0600 Subject: [PATCH] Basic Sphinx site. --- docs/Makefile | 20 ++++++++++++++++++++ docs/conf.py | 23 +++++++++++++++++++++++ docs/index.rst | 20 ++++++++++++++++++++ requirements.txt | 1 + 4 files changed, 64 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..0c4ce84 --- /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 = stix2 +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..efec020 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,23 @@ +extensions = [] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' + +project = 'stix2' +copyright = '2017, OASIS Open' +author = 'OASIS Open' + +version = '0.0.1' +release = '0.0.1' + +language = None +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +pygments_style = 'sphinx' +todo_include_todos = False + +html_theme = 'alabaster' + +latex_elements = {} +latex_documents = [ + (master_doc, 'stix2.tex', 'stix2 Documentation', 'OASIS', 'manual'), +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2cd05ba --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. stix2 documentation master file, created by + sphinx-quickstart on Tue Feb 14 15:36:06 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to stix2's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/requirements.txt b/requirements.txt index d10154e..1a145c8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,6 @@ pytest tox pytest-cov +sphinx -e .