Merge pull request #81 from ghislainv/dev

Catching version number in docsrc/conf.py for Sphinx

docsrc/conf.py

@@ -25,7 +25,7 @@
 # The full version, including alpha/beta/rc tags
 version = re.search(
     '^__version__\s*=\s*"(.*)"',
-    open('../forestatrisk/forestatrisk.py').read(),
+    open('../forestatrisk/__init__.py').read(),
     re.M
     ).group(1)
 release = version

forestatrisk/__init__.py

@@ -10,9 +10,7 @@
 # ==============================================================================
 
 """forestatrisk: modelling and forecasting deforestation in the tropics.
-
-https://ecology.ghislainv.fr/forestatrisk/
-"""
+https://ecology.ghislainv.fr/forestatrisk/"""
 
 # Standard library imports
 from __future__ import division, print_function  # Python 3 compatibility

forestatrisk/forestatrisk.py

@@ -17,11 +17,13 @@
 def main():
     """forestatrisk.forestatrisk: provides entry point main().
 
-    Running ``forestatrisk`` in the terminal prints ForestAtRisk
+    Running ``forestatrisk`` in the terminal prints ``forestatrisk``
     description and version. Can be used to check that the
-    ``forestatrisk`` Python package can be correctly imported.
+    ``forestatrisk`` Python package has been correctly imported.
 
     """
-    print("# forestatrisk version {}.".format(far.__version__))
+
+    print(far.__doc__)
+    print("version {}.".format(far.__version__))
 
 # End

setup.py

@@ -23,7 +23,7 @@
 # find_version
 def find_version():
     """Finding package version."""
-    with open('forestatrisk/__init__.py', encoding="utf-8") as init_file:
+    with open("forestatrisk/__init__.py", encoding="utf-8") as init_file:
         init_text = init_file.read()
     far_version = re.search(
         '^__version__\\s*=\\s*"(.*)"',