Basic Sphinx site.
parent
be0e11fd5c
commit
610f24fe54
|
@ -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)
|
|
@ -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'),
|
||||||
|
]
|
|
@ -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`
|
|
@ -1,5 +1,6 @@
|
||||||
pytest
|
pytest
|
||||||
tox
|
tox
|
||||||
pytest-cov
|
pytest-cov
|
||||||
|
sphinx
|
||||||
|
|
||||||
-e .
|
-e .
|
||||||
|
|
Loading…
Reference in New Issue