summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2017-03-13 21:40:56 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2017-03-13 21:40:56 -0400
commit8c1e01886853471d8dadd473f491f310937b01d0 (patch)
treef41bf6a8699495575640d0d8fda37d45d0e4d056 /docs/conf.py
parent8b0505c5ccdc7516572afe1426d82666f97232af (diff)
downloadcmd2-git-8c1e01886853471d8dadd473f491f310937b01d0.tar.gz
Mostly fix a bunch of spelling mistakes.
A few other miscellaneous minor tweaks for whitespace and such.
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py37
1 files changed, 19 insertions, 18 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 0627f94c..60a28d13 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,29 +1,30 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
-#
-# cmd2 documentation build configuration file, created by
-# sphinx-quickstart on Wed Feb 10 12:05:28 2010.
-#
-# 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.
+"""
+cmd2 documentation build configuration file, created by
+sphinx-quickstart on Wed Feb 10 12:05:28 2010.
-# 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.
-#
+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.
+"""
import os
import sys
-sys.path.insert(0, os.path.abspath('..'))
-
# Import for custom theme from Read the Docs
import sphinx_rtd_theme
+sys.path.insert(0, os.path.abspath('..'))
+
+
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.