diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..fd39b782 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +_build +_static +_templates diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..fd967611 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,26 @@ +# Makefile for Sphinx documentation + +SPHINXOPTS = +SPHINXBUILD = sphinx-build2 +PAPER = +BUILDDIR = _build + +# Internal variables +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..64b3266d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,18 @@ +# -*- coding: utf-8 -*- + +import sys, os + +sys.path.insert(0, os.path.abspath('../powerline')) + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' +project = u'Powerline' +copyright = u'Kim Silkebækken' +version = 'dev' +release = 'dev' +exclude_patterns = ['_build'] +pygments_style = 'sphinx' +html_theme = 'nature' +html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..07d14c06 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +Powerline +========= + +.. toctree:: + :maxdepth: 3 + :glob: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`