diff options
author | Rémi Flamary <remi.flamary@gmail.com> | 2016-11-08 08:14:28 +0100 |
---|---|---|
committer | Rémi Flamary <remi.flamary@gmail.com> | 2016-11-08 08:14:28 +0100 |
commit | a7c772befe03364bf2f99db29d2e23788bd91ed8 (patch) | |
tree | 10f7b2ec5722fb80d2fd6691f8692e18fca06b0e | |
parent | 8097bdda7c0fbd469eecb55fc0a1e93dd53b7fb8 (diff) |
update doc
-rw-r--r-- | docs/source/conf.py | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 2bb0e81..eadb396 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -71,7 +71,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'POT' +project = u'POT Python Optimal Transport library' copyright = u'2016, Rémi Flamary, Nicolas Courty' author = u'Rémi Flamary, Nicolas Courty' @@ -79,10 +79,14 @@ author = u'Rémi Flamary, Nicolas Courty' # |version| and |release|, also used in various other places throughout the # built documents. # + +__version__ = re.search( + r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]', # It excludes inline comment too + open('ot/__init__.py').read()).group(1) # The short X.Y version. -version = u'0.1' +version = __version__ # The full version, including alpha/beta/rc tags. -release = u'0.1' +release = __version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -247,7 +251,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'POT.tex', u'POT Documentation', + (master_doc, 'POT.tex', u'POT Python Optimal Transport library', u'Rémi Flamary, Nicolas Courty', 'manual'), ] @@ -277,7 +281,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'pot', u'POT Documentation', + (master_doc, 'pot', u'POT Python Optimal Transport library Documentation', [author], 1) ] @@ -291,7 +295,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'POT', u'POT Documentation', + (master_doc, 'POT', u'POT Python Optimal Transport library Documentation', author, 'POT', 'One line description of project.', 'Miscellaneous'), ] |