DOC/CI: include api docs on travis

.travis.yml

@@ -18,6 +18,7 @@ git:
 
 matrix:
     fast_finish: true
+    fail_fast: true
     include:
     - python: 2.6
       env:
@@ -42,7 +43,6 @@ matrix:
       - FULL_DEPS=true
       - CLIPBOARD_GUI=gtk2
       - BUILD_TYPE=conda
-      - DOC_BUILD=true # if rst files were changed, build docs in parallel with tests
     - python: 3.4
       env:
       - JOB_NAME: "34_nslow"
@@ -103,6 +103,12 @@ matrix:
       - NUMPY_BUILD=master
       - BUILD_TYPE=pydata
       - PANDAS_TESTING_MODE="deprecate"
+    - python: 2.7
+      env:
+      - JOB_NAME: "doc_build"
+      - JOB_TAG=_DOC_BUILD
+      - BUILD_TYPE=conda
+      - DOC_BUILD=true # if rst files were changed, build docs in parallel with tests
     allow_failures:
       - python: 3.3
         env:
@@ -150,6 +156,12 @@ matrix:
         - FULL_DEPS=true
         - BUILD_TYPE=pydata
         - BUILD_TEST=true
+      - python: 2.7
+        env:
+        - JOB_NAME: "doc_build"
+        - JOB_TAG=_DOC_BUILD
+        - BUILD_TYPE=conda
+        - DOC_BUILD=true
 
 before_install:
   - echo "before_install"
@@ -178,7 +190,7 @@ before_script:
 
 script:
   - echo "script"
-  - ci/run_build_docs.sh &
+  - ci/run_build_docs.sh
   - ci/script.sh
 # nothing here, or failed tests won't fail travis
 

ci/before_install.sh

@@ -11,3 +11,7 @@ echo "inside $0"
 sudo apt-get update $APT_ARGS # run apt-get update for all versions
 
 true # never fail because bad things happened here
+
+if [ x"$DOC_BUILD" == x"" ]; then
+    exit 1
+fi

ci/build_docs.sh

@@ -14,23 +14,22 @@ fi
 
 if [ x"$DOC_BUILD" != x"" ]; then
 
-    # we're running network tests, let's build the docs in the meantime
     echo "Will build docs"
-    conda install -n pandas sphinx=1.1.3 pygments ipython=2.4 --yes
 
     source activate pandas
+    conda install -n pandas -c r r rpy2 --yes
+
+    time sudo apt-get $APT_ARGS install dvipng
 
     mv "$TRAVIS_BUILD_DIR"/doc /tmp
     cd /tmp/doc
 
-    rm /tmp/doc/source/api.rst # no R
-    rm /tmp/doc/source/r_interface.rst # no R
-
     echo ###############################
     echo # Log file for the doc build  #
     echo ###############################
 
-    echo -e "y\n" | ./make.py --no-api 2>&1
+    echo ./make.py
+    ./make.py
 
     cd /tmp/doc/build/html
     git config --global user.email "[email protected]"

ci/requirements-2.7_DOC_BUILD.build

@@ -0,0 +1,4 @@
+dateutil
+pytz
+numpy
+cython

ci/requirements-2.7_DOC_BUILD.run

@@ -0,0 +1,16 @@
+sphinx=1.2.3
+ipython=3.2.1
+matplotlib
+scipy
+lxml
+beautiful-soup
+html5lib
+pytables
+openpyxl=1.8.5
+xlrd
+xlwt
+xlsxwriter
+sqlalchemy
+numexpr
+bottleneck
+statsmodels

ci/run_build_docs.sh

@@ -2,7 +2,7 @@
 
 echo "inside $0"
 
-"$TRAVIS_BUILD_DIR"/ci/build_docs.sh 2>&1 > /tmp/doc.log &
+"$TRAVIS_BUILD_DIR"/ci/build_docs.sh 2>&1
 
 # wait until subprocesses finish (build_docs.sh)
 wait

ci/script.sh

@@ -4,6 +4,11 @@ echo "inside $0"
 
 source activate pandas
 
+# don't run the tests for the doc build
+if [ x"$DOC_BUILD" != x"" ]; then
+    exit 0
+fi
+
 if [ -n "$LOCALE_OVERRIDE" ]; then
     export LC_ALL="$LOCALE_OVERRIDE";
     echo "Setting LC_ALL to $LOCALE_OVERRIDE"

doc/make.py

@@ -104,7 +104,7 @@ def clean():
 
 def html():
     check_build()
-    if os.system('sphinx-build -P -b html -d build/doctrees '
+    if os.system('sphinx-build -P -j 4 -b html -d build/doctrees '
                  'source build/html'):
         raise SystemExit("Building HTML failed.")
     try:

doc/source/api.rst

@@ -603,7 +603,7 @@ strings and apply several methods to it. These can be acccessed like
 
 ..
     The following is needed to ensure the generated pages are created with the
-    correct template (otherwise they would be created in the Series class page)
+    correct template (otherwise they would be created in the Series/Index class page)
 
 ..
     .. autosummary::
@@ -613,6 +613,10 @@ strings and apply several methods to it. These can be acccessed like
        Series.str
        Series.cat
        Series.dt
+       Index.str
+       CategoricalIndex.str
+       DatetimeIndex.str
+       TimedeltaIndex.str
 
 
 .. _api.categorical:

doc/sphinxext/numpydoc/docscrape_sphinx.py

@@ -19,6 +19,7 @@ def __init__(self, docstring, config={}):
     def load_config(self, config):
         self.use_plots = config.get('use_plots', False)
         self.class_members_toctree = config.get('class_members_toctree', True)
+        self.class_members_list = config.get('class_members_list', True)
 
     # string conversion routines
     def _str_header(self, name, symbol='`'):
@@ -95,7 +96,7 @@ def _str_member_list(self, name):
 
         """
         out = []
-        if self[name]:
+        if self[name] and self.class_members_list:
             out += ['.. rubric:: %s' % name, '']
             prefix = getattr(self, '_name', '')
 
@@ -114,11 +115,13 @@ def _str_member_list(self, name):
                         or inspect.isgetsetdescriptor(param_obj)):
                     param_obj = None
 
-                if param_obj and (pydoc.getdoc(param_obj) or not desc):
-                    # Referenced object has a docstring
-                    autosum += ["   %s%s" % (prefix, param)]
-                else:
-                    others.append((param, param_type, desc))
+                # pandas HACK - do not exclude attributes wich are None
+                # if param_obj and (pydoc.getdoc(param_obj) or not desc):
+                #     # Referenced object has a docstring
+                #     autosum += ["   %s%s" % (prefix, param)]
+                # else:
+                #     others.append((param, param_type, desc))
+                autosum += ["   %s%s" % (prefix, param)]
 
             if autosum:
                 out += ['.. autosummary::']

doc/sphinxext/numpydoc/numpydoc.py

@@ -42,6 +42,10 @@ def mangle_docstrings(app, what, name, obj, options, lines,
                class_members_toctree=app.config.numpydoc_class_members_toctree,
               )
 
+    # PANDAS HACK (to remove the list of methods/attributes for Categorical)
+    if what == "class" and name.endswith(".Categorical"):
+        cfg['class_members_list'] = False
+
     if what == 'module':
         # Strip top title
         title_re = re.compile(sixu('^\\s*[#*=]{4,}\\n[a-z0-9 -]+\\n[#*=]{4,}\\s*'),