Add Sphinx docs skeleton

This commit is contained in:
Kim Silkebækken 2012-12-13 15:43:05 +01:00
parent e5c864ec1b
commit cd41910fb3
4 changed files with 60 additions and 0 deletions

3
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
_build
_static
_templates

26
docs/Makefile Normal file
View File

@ -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 <target>' where <target> 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."

18
docs/conf.py Normal file
View File

@ -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']

13
docs/index.rst Normal file
View File

@ -0,0 +1,13 @@
Powerline
=========
.. toctree::
:maxdepth: 3
:glob:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`