Document config options

.gitignore

@@ -3,6 +3,7 @@ build
 dist
 _build
 docs/gh-pages
+docs/config_options.rst
 *.py[co]
 __pycache__
 *.egg-info

docs/Makefile

@@ -51,11 +51,15 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 
-html:
+html: config_options.rst
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+config_options.rst:
+	python3 autogen_config.py
+	@echo "Created docs for config options"
+
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo

docs/autogen_config.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+import os.path
+from jupyter_console.app import ZMQTerminalIPythonApp
+
+header = """\
+Configuration options
+=====================
+
+These options can be set in ``~/.jupyter/jupyter_console_config.py``, or
+at the command line when you start it.
+"""
+
+destination = os.path.join(os.path.dirname(__file__), 'config_options.rst')
+
+with open(destination, 'w') as f:
+    f.write(header)
+    f.write(ZMQTerminalIPythonApp().document_config_options())

docs/index.rst

@@ -1,11 +1,14 @@
 Jupyter console |version|
 =========================
 
+The Jupyter console is a terminal frontend for kernels using the Jupyter protocol.
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   config_options
 
 
 Indices and tables