Switch doc theme to Bootstrap. Plus doc fixes.

inducer · Apr 29, 2013 · d106166 · d106166
1 parent b3f00f4
commit d106166
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 13 deletions.
diff --git a/doc/source/_static/akdoc.css b/doc/source/_static/akdoc.css
@@ -0,0 +1,53 @@
+pre {
+  line-height: 100%;
+}
+
+.footer {
+  background-color: #eee;
+}
+
+body > div.container {
+  margin-top:10px;
+}
+
+dd {
+  margin-left: 40px;
+}
+
+tt.descname {
+  font-size: 100%;
+}
+
+code {
+  color: rgb(51,51,51);
+}
+
+h1 {
+  padding-bottom:5px;
+  border-bottom: 1px solid #ccc;
+}
+
+h2 {
+  padding-bottom:1px;
+  border-bottom: 1px solid #ccc;
+}
+
+h3 {
+  padding-bottom:1px;
+  border-bottom: 1px solid #ccc;
+}
+
+.rubric {
+  font-size: 120%;
+  padding-bottom:1px;
+  border-bottom: 1px solid #ccc;
+}
+
+.headerlink {
+  padding-left: 1ex;
+  padding-right: 1ex;
+}
+
+a.headerlink:hover {
+  text-decoration: none;
+}
diff --git a/doc/source/_templates/layout.html b/doc/source/_templates/layout.html
@@ -0,0 +1,2 @@
+{% extends "!layout.html" %}
+{% set css_files = css_files + ['_static/akdoc.css']%}
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -34,7 +34,7 @@
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -100,10 +100,28 @@
 # Options for HTML output
 # -----------------------
 
+try:
+    import sphinx_bootstrap_theme
+except:
+    from warnings import warn
+    warn("I would like to use the sphinx bootstrap theme, but can't find it.\n"
+            "'pip install sphinx_bootstrap_theme' to fix.")
+else:
+    # Activate the theme.
+    html_theme = 'bootstrap'
+    html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+    # 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
+    # documentation.
+    html_theme_options = {
+            'navbar_fixed_top': "true",
+            'navbar_class': "navbar navbar-inverse",
+            }
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
-html_style = 'default.css'
+#html_style = 'default.css'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -124,7 +142,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

diff --git a/doc/source/jit.rst b/doc/source/jit.rst
@@ -11,22 +11,14 @@ to determine a few configuration values, notably:
 * `BOOST_COMPILER` (used in the default libnames)
 * `CUDA_ROOT`
 
-For lack of better documentation at this moment, please see `this wiki page
-<http://wiki.tiker.net/Hedge/HowTo/InstallingFromGit>`_.
+For lack of better installation documentation at this moment, please see `this
+wiki page <http://wiki.tiker.net/Hedge/HowTo/InstallingFromGit>`_.
 
 :mod:`codepy.jit` -- Compilation and Linking of C Source Code
 -------------------------------------------------------------
 
 .. module:: codepy.jit
 
-.. autoclass:: Toolchain
-    :members: copy, get_version, abi_id, add_library, build_extension
-    :undoc-members:
-
-.. autoclass:: GCCToolchain
-    :show-inheritance:
-
-.. autofunction:: guess_toolchain
 .. autofunction:: extension_file_from_string
 .. autofunction:: extension_from_string
 
@@ -35,8 +27,21 @@ Errors
 
 .. autoexception:: CompileError
 
+:mod:`codepy.toolchain` -- Tool support code
+--------------------------------------------
+
+.. module:: codepy.toolchain
+
 .. autoexception:: ToolchainGuessError
 
+.. autoclass:: Toolchain
+    :members: copy, get_version, abi_id, add_library, build_extension
+    :undoc-members:
+
+.. autoclass:: GCCToolchain
+    :show-inheritance:
+
+.. autofunction:: guess_toolchain
 
 :mod:`codepy.bpl` -- Support for Boost.Python
 ---------------------------------------------