Docs: Add a nice looking summary to the apidoc

.travis.yml

@@ -15,5 +15,6 @@ install:
     - cd ..
     - ./convert_to_py2.sh
     - pip install -e .[all]
+    - pip install -r docs_requirements.txt
     - sudo apt-get install texlive-latex-extra texlive-pictures texlive-science
 script: ./testall.sh

docs/source/conf.py

@@ -31,14 +31,19 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'numpydoc',
     'sphinx.ext.doctest',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.autosummary',
 ]
 
+numpydoc_show_inherited_class_members = False
+numpydoc_class_members_toctree = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs_requirements.txt

@@ -0,0 +1 @@
+git+https://github.com/numpy/numpydoc.git@16ef04c

pylatex/base_classes/latex_object.py

@@ -41,15 +41,15 @@ def dumps(self):
         class.
         """
 
-    def dump(self, file_):
+    def dump(self, file_w):
         """Write the LaTeX representation of the class to a file.
 
-        :param file_: The file object in which to save the data
+        :param file_w: The file object in which to save the data
 
-        :type file_: io.TextIOBase
+        :type file_w: io.TextIOBase
         """
 
-        file_.write(self.dumps())
+        file_w.write(self.dumps())
 
     def generate_tex(self, filepath):
         """Generate a .tex file.
@@ -70,12 +70,12 @@ def dumps_packages(self):
 
         return dumps_list(self.packages)
 
-    def dump_packages(self, file_):
+    def dump_packages(self, file_w):
         """Write the LaTeX representation of the packages to a file.
 
-        :param file_: The file object in which to save the data
+        :param file_w: The file object in which to save the data
 
-        :type file_: io.TextIOBase
+        :type file_w: io.TextIOBase
         """
 
-        file_.write(self.dumps_packages())
+        file_w.write(self.dumps_packages())

setup.py

@@ -177,7 +177,7 @@
     'matrices': ['numpy'],
     'matplotlib': ['matplotlib'],
     'quantities': ['quantities', 'numpy'],
-    'testing': ['flake8', 'pep8-naming', 'flake8_docstrings', 'nose'],
+    'testing': ['flake8', 'pep8-naming', 'flake8_docstrings', 'nose']
 }
 
 extras['all'] = list(set([req for reqs in extras.values() for req in reqs]))