Add getting started doc for dev environment

also change docs theme
This commit is contained in:
Lance Edgar 2018-01-11 12:15:19 -06:00
parent c750ea2355
commit 99ed897bf4
5 changed files with 104 additions and 8 deletions

View file

@ -1,4 +1,4 @@
# -*- coding: utf-8 -*-
# -*- coding: utf-8; -*-
#
# Tailbone documentation build configuration file, created by
# sphinx-quickstart on Sat Feb 15 23:15:27 2014.
@ -15,6 +15,8 @@
import sys
import os
import sphinx_rtd_theme
exec(open(os.path.join(os.pardir, 'tailbone', '_version.py')).read())
@ -58,14 +60,15 @@ master_doc = 'index'
# General information about the project.
project = u'Tailbone'
copyright = u'2015, Lance Edgar'
copyright = u'2010 - 2018, Lance Edgar'
# 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 = '0.3'
# version = '0.3'
version = '.'.join(__version__.split('.')[:2])
# The full version, including alpha/beta/rc tags.
release = __version__
@ -112,7 +115,8 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'classic'
# html_theme = 'classic'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -121,6 +125,7 @@ html_theme = 'classic'
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@ -132,6 +137,7 @@ html_theme = 'classic'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = 'images/rattail_avatar.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32