Use sphinxcontrib-napoleon

Martin Journois · Martin Journois · commit f327c36e7639 · 2016-01-18T15:55:12.000+01:00
diff --git a/docs/_themes/f6/README.rst b/docs/_themes/f6/README.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 
 # 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.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
diff --git a/docs/installing.rst b/docs/installing.rst
@@ -19,6 +19,7 @@ Easiest
 ::
 
 $pip install folium
+
 Or from the source
 
 $python setup.py install
@@ -69,14 +70,16 @@ To build the docs, you'll also need to install:
 ::
 
  sphinx
+ sphinxcontrib-napoleon
 
 Then go in folium base folder (`~/sandbox/folium` for example)
 ::
 
 $ cd ~/sandbox/folium
 
-Run the test
+Build the docs
 ::
 
-$ sphinx-build -b html docs/ docs/_build/html
+$ rm -rf docs/_build; sphinx-build -b html docs/ docs/_build/html
 
+Then the documentation is in `docs/_build/html/index.html`.
diff --git a/docs/module.rst b/docs/module.rst
@@ -1,4 +1,3 @@
-.. _module::
 ModuleDescription
 *****************
 
@@ -7,7 +6,7 @@ ModuleDescription
 
 .. toctree::
    :maxdepth: 3
-   
+
    module/element
 
 :doc:`Map </module/map>`
