]> gitweb.michael.orlitzky.com - dunshire.git/blobdiff - doc/source/conf.py
Remove package/module names and rst source links from the HTML docs.
[dunshire.git] / doc / source / conf.py
index baf787e31df7d587fe990fb203b81f8777aba941..d8c6a9b0242862af8dc408fd6edbbe26a3232d7a 100644 (file)
@@ -40,10 +40,10 @@ copyright = '2016, Michael Orlitzky'
 author = 'Michael Orlitzky'
 
 # The short X.Y version.
-version = '0.0.1'
+version = '0.1.0'
 
 # The full version, including alpha/beta/rc tags.
-release = '0.0.1'
+release = '0.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -56,6 +56,9 @@ language = None
 # directories to ignore when looking for source files.
 exclude_patterns = []
 
+# Don't show "dunshire.games" before every damned method.
+add_module_names = False
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
@@ -102,7 +105,11 @@ html_show_sphinx = False
 html_show_copyright = False
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+html_file_suffix = ".xhtml"
+
+# Don't include the restructured text source files for the XHTML
+# pages, and don't display a link to them either.
+html_show_sourcelink = False
 
 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
@@ -114,14 +121,16 @@ htmlhelp_basename = 'dunshiredoc'
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
+    'preamble' : '\usepackage{amsfonts,amssymb}',
+    'printindex' : ''
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'dunshire.tex', 'Dunshire Documentation',
-   'author', 'manual'),
+  (master_doc, 'dunshire.tex', project + ' Documentation',
+   author, 'manual'),
 ]
 
 # -- Options for manual page output ---------------------------------------
@@ -129,7 +138,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'Dunshire', 'Dunshire Documentation',
+    (master_doc, project, project + ' Documentation',
      [author], 1)
 ]
 
@@ -143,7 +152,7 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'Dunshire', 'Dunshire Documentation',
+  (master_doc, project, project + ' Documentation',
    author, 'derp', 'One line description of project.',
    'Miscellaneous'),
 ]