Add labels to documentation sections

[linpy.git] / doc / conf.py

diff --git a/doc/conf.py b/doc/conf.py
index 09d9f8d..b06c693 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #

-# pypol documentation build configuration file, created by
+# LinPy documentation build configuration file, created by

 # sphinx-quickstart on Wed Jun 25 20:34:21 2014.
 #
 # This file is execfile()d with the current directory set to its
 # sphinx-quickstart on Wed Jun 25 20:34:21 2014.
 #
 # This file is execfile()d with the current directory set to its


@@ -29,9 +29,7 @@ import os
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.

-extensions = [
-    'sphinx.ext.mathjax',
-]
+extensions = []

 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']


@@ -46,7 +44,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
 master_doc = 'index'
 
 # General information about the project.

-project = 'pypol'
+project = 'LinPy'

 copyright = '2014, MINES ParisTech'
 
 # The version info for the project you're documenting, acts as replacement for
 copyright = '2014, MINES ParisTech'
 
 # The version info for the project you're documenting, acts as replacement for


@@ -54,9 +52,9 @@ copyright = '2014, MINES ParisTech'
 # built documents.
 #
 # The short X.Y version.
 # built documents.
 #
 # The short X.Y version.

-version = ''
+version = '1.0'

 # The full version, including alpha/beta/rc tags.
 # The full version, including alpha/beta/rc tags.

-release = ''
+release = '1.0a'

 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.


@@ -179,7 +177,7 @@ html_static_path = ['_static']
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.

-htmlhelp_basename = 'pypoldoc'
+htmlhelp_basename = 'LinPydoc'

 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 
 # -- Options for LaTeX output ---------------------------------------------


@@ -199,7 +197,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [

-  ('index', 'pypol.tex', 'pypol Documentation',
+  ('index', 'LinPy.tex', 'LinPy Documentation',

    'MINES ParisTech', 'manual'),
 ]
 
    'MINES ParisTech', 'manual'),
 ]
 


@@ -229,7 +227,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [

-    ('index', 'pypol', 'pypol Documentation',
+    ('index', 'LinPy', 'LinPy Documentation',

      ['MINES ParisTech'], 1)
 ]
 
      ['MINES ParisTech'], 1)
 ]
 


@@ -243,8 +241,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [

-  ('index', 'pypol', 'pypol Documentation',
-   'MINES ParisTech', 'pypol', 'One line description of project.',
+  ('index', 'LinPy', 'LinPy Documentation',
+   'MINES ParisTech', 'LinPy', 'A polyheral library based on isl.',

    'Miscellaneous'),
 ]
 
    'Miscellaneous'),
 ]