With this we can generate HTML for the docs in this directory. For the moment, more as an experiment as anything else, this doc is available at http://sparse-doc.rtfd.io Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx> --- Documentation/.gitignore | 1 + Documentation/Makefile | 22 +++++++ Documentation/conf.py | 161 +++++++++++++++++++++++++++++++++++++++++++++++ Documentation/index.rst | 28 +++++++++ 4 files changed, 212 insertions(+) create mode 100644 Documentation/.gitignore create mode 100644 Documentation/Makefile create mode 100644 Documentation/conf.py create mode 100644 Documentation/index.rst diff --git a/Documentation/.gitignore b/Documentation/.gitignore new file mode 100644 index 000000000..378eac25d --- /dev/null +++ b/Documentation/.gitignore @@ -0,0 +1 @@ +build diff --git a/Documentation/Makefile b/Documentation/Makefile new file mode 100644 index 000000000..8bb5b9e49 --- /dev/null +++ b/Documentation/Makefile @@ -0,0 +1,22 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = -a +SPHINXBUILD = sphinx-build +SPHINXPROJ = sparse +SOURCEDIR = . +BUILDDIR = build + +targets := help +targets += html + + +# Put it first so that "make" without argument is like "make help". +help: + +# route all targets to Sphinx using the new "make mode" option. +$(targets): conf.py Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) + +.PHONY: Makefile # avoid circular deps with the catch-all rule diff --git a/Documentation/conf.py b/Documentation/conf.py new file mode 100644 index 000000000..99cd39997 --- /dev/null +++ b/Documentation/conf.py @@ -0,0 +1,161 @@ +# -*- coding: utf-8 -*- +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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. +# sys.path.insert(0, os.path.abspath('.')) + +# +# import os +# import sys + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = ['.rst', '.md'] + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'sparse' +copyright = '2017' +author = "sparse's development community" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.5.9' +# The full version, including alpha/beta/rc tags. +release = u'0.5.9' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['build'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + +# -- 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 = 'classic' +# html_theme_options = {} + +# 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 = ['sphinx/static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + +html_logo = None + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'sparsedoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + 'papersize': 'a4paper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'sparse.tex', u'sparse Documentation', author, 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('sparse', 'sparse', u'Semantic Parser for C', [u'Linus Torvalds', author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'sparse', u'sparse Documentation', author, 'sparse', 'C semantic parser & checker', 'Software development'), +] + + +# vim: tabstop=4 diff --git a/Documentation/index.rst b/Documentation/index.rst new file mode 100644 index 000000000..f68bb42f2 --- /dev/null +++ b/Documentation/index.rst @@ -0,0 +1,28 @@ +.. sparse documentation master file. + +Welcome to sparse's documentation +================================= + +.. toctree:: + :maxdepth: 1 + +Developer documentation +----------------------- +.. toctree:: + :maxdepth: 1 + + options + IR + +How to contribute +----------------- +.. toctree:: + :maxdepth: 1 + + submitting-patches + project-ideas + +Indices and tables +================== + +* :ref:`genindex` -- 2.16.0 -- To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
