Skip to content

Commit 1330b9f

Browse files
DOC/CI: include api docs on travis
Continuation of #11069 (It seems I cannot reopen that PR because I already force pushed the branch ..) Closes #3800 TODO: - [x] remove printing of doc build log file in after_script Author: Joris Van den Bossche <[email protected]> Closes #12002 from jorisvandenbossche/travis-full-doc and squashes the following commits: 2aaa92d [Joris Van den Bossche] DOC fixes d9af945 [Joris Van den Bossche] Install latest sphinx version with pip c8e58b0 [Joris Van den Bossche] DOC/CI: include api docs on travis
1 parent 49c0023 commit 1330b9f

9 files changed

+61
-23
lines changed

.travis.yml

+15-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ matrix:
4242
- NOSE_ARGS="not slow and not disabled"
4343
- FULL_DEPS=true
4444
- CLIPBOARD_GUI=gtk2
45-
- DOC_BUILD=true # if rst files were changed, build docs in parallel with tests
4645
- python: 3.4
4746
env:
4847
- JOB_NAME: "34_nslow"
@@ -88,6 +87,13 @@ matrix:
8887
- JOB_TAG=_NUMPY_DEV
8988
- NOSE_ARGS="not slow and not network and not disabled"
9089
- PANDAS_TESTING_MODE="deprecate"
90+
- python: 2.7
91+
env:
92+
- JOB_NAME: "doc_build"
93+
- FULL_DEPS=true
94+
- BUILD_TYPE=conda
95+
- DOC_BUILD=true # if rst files were changed, build docs in parallel with tests
96+
- JOB_TAG=_DOC_BUILD
9197
allow_failures:
9298
- python: 2.7
9399
env:
@@ -121,6 +127,13 @@ matrix:
121127
- JOB_TAG=_NUMPY_DEV
122128
- NOSE_ARGS="not slow and not network and not disabled"
123129
- PANDAS_TESTING_MODE="deprecate"
130+
- python: 2.7
131+
env:
132+
- JOB_NAME: "doc_build"
133+
- FULL_DEPS=true
134+
- BUILD_TYPE=conda
135+
- DOC_BUILD=true
136+
- JOB_TAG=_DOC_BUILD
124137

125138
before_install:
126139
- echo "before_install"
@@ -149,13 +162,12 @@ before_script:
149162

150163
script:
151164
- echo "script"
152-
- ci/run_build_docs.sh &
165+
- ci/run_build_docs.sh
153166
- ci/script.sh
154167
# nothing here, or failed tests won't fail travis
155168

156169
after_script:
157170
- ci/install_test.sh
158-
- if [ -f /tmp/doc.log ]; then cat /tmp/doc.log; fi
159171
- source activate pandas && ci/print_versions.py
160172
- ci/print_skipped.py /tmp/nosetests.xml
161173
- ci/lint.sh

ci/build_docs.sh

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,23 @@ fi
1414

1515
if [ x"$DOC_BUILD" != x"" ]; then
1616

17-
# we're running network tests, let's build the docs in the meantime
1817
echo "Will build docs"
19-
conda install -n pandas sphinx=1.1.3 pygments ipython=2.4 --yes
2018

2119
source activate pandas
20+
conda install -n pandas -c r r rpy2 --yes
21+
pip install sphinx -U
22+
23+
time sudo apt-get $APT_ARGS install dvipng
2224

2325
mv "$TRAVIS_BUILD_DIR"/doc /tmp
2426
cd /tmp/doc
2527

26-
rm /tmp/doc/source/api.rst # no R
27-
rm /tmp/doc/source/r_interface.rst # no R
28-
2928
echo ###############################
3029
echo # Log file for the doc build #
3130
echo ###############################
3231

33-
echo -e "y\n" | ./make.py --no-api 2>&1
32+
echo ./make.py
33+
./make.py
3434

3535
cd /tmp/doc/build/html
3636
git config --global user.email "[email protected]"

ci/requirements-2.7_DOC_BUILD.build

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dateutil
2+
pytz
3+
numpy
4+
cython

ci/requirements-2.7_DOC_BUILD.run

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
ipython=3.2.1
2+
nbconvert
3+
matplotlib
4+
scipy
5+
lxml
6+
beautiful-soup
7+
html5lib
8+
pytables
9+
openpyxl=1.8.5
10+
xlrd
11+
xlwt
12+
xlsxwriter
13+
sqlalchemy
14+
numexpr
15+
bottleneck
16+
statsmodels

ci/run_build_docs.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
echo "inside $0"
44

5-
"$TRAVIS_BUILD_DIR"/ci/build_docs.sh 2>&1 > /tmp/doc.log &
5+
"$TRAVIS_BUILD_DIR"/ci/build_docs.sh 2>&1
66

77
# wait until subprocesses finish (build_docs.sh)
88
wait

ci/script.sh

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ echo "inside $0"
44

55
source activate pandas
66

7+
# don't run the tests for the doc build
8+
if [ x"$DOC_BUILD" != x"" ]; then
9+
exit 0
10+
fi
11+
712
if [ -n "$LOCALE_OVERRIDE" ]; then
813
export LC_ALL="$LOCALE_OVERRIDE";
914
echo "Setting LC_ALL to $LOCALE_OVERRIDE"

pandas/core/frame.py

+8-7
Original file line numberDiff line numberDiff line change
@@ -4918,12 +4918,13 @@ def quantile(self, q=0.5, axis=0, numeric_only=True,
49184918
.. versionadded:: 0.18.0
49194919
This optional parameter specifies the interpolation method to use,
49204920
when the desired quantile lies between two data points `i` and `j`:
4921-
* linear: `i + (j - i) * fraction`, where `fraction` is the
4922-
fractional part of the index surrounded by `i` and `j`.
4923-
* lower: `i`.
4924-
* higher: `j`.
4925-
* nearest: `i` or `j` whichever is nearest.
4926-
* midpoint: (`i` + `j`) / 2.
4921+
4922+
* linear: `i + (j - i) * fraction`, where `fraction` is the
4923+
fractional part of the index surrounded by `i` and `j`.
4924+
* lower: `i`.
4925+
* higher: `j`.
4926+
* nearest: `i` or `j` whichever is nearest.
4927+
* midpoint: (`i` + `j`) / 2.
49274928
49284929
Returns
49294930
-------
@@ -4938,7 +4939,7 @@ def quantile(self, q=0.5, axis=0, numeric_only=True,
49384939
--------
49394940
49404941
>>> df = DataFrame(np.array([[1, 1], [2, 10], [3, 100], [4, 100]]),
4941-
columns=['a', 'b'])
4942+
columns=['a', 'b'])
49424943
>>> df.quantile(.1)
49434944
a 1.3
49444945
b 3.7

pandas/core/window.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ def count(self):
511511
----------
512512
func : function
513513
Must produce a single value from an ndarray input
514-
*args and **kwargs are passed to the function""")
514+
\*args and \*\*kwargs are passed to the function""")
515515

516516
def apply(self, func, args=(), kwargs={}):
517517
# TODO: _level is unused?

pandas/util/nosetester.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ def test(self, label='fast', verbose=1, extra_argv=None,
138138
* 'full' - fast (as above) and slow tests as in the
139139
'no -A' option to nosetests - this is the same as ''.
140140
* None or '' - run all tests.
141-
attribute_identifier - string passed directly to nosetests as '-A'.
141+
* attribute_identifier - string passed directly to nosetests as '-A'.
142142
verbose : int, optional
143143
Verbosity value for test outputs, in the range 1-10. Default is 1.
144144
extra_argv : list, optional
@@ -147,14 +147,14 @@ def test(self, label='fast', verbose=1, extra_argv=None,
147147
If True, run doctests in module. Default is False.
148148
coverage : bool, optional
149149
If True, report coverage of NumPy code. Default is False.
150-
(This requires the `coverage module:
151-
<http://nedbatchelder.com/code/modules/coverage.html>`_).
150+
(This requires the `coverage module
151+
<http://nedbatchelder.com/code/modules/coverage.html>`_).
152152
raise_warnings : str or sequence of warnings, optional
153153
This specifies which warnings to configure as 'raise' instead
154154
of 'warn' during the test execution. Valid strings are:
155155
156-
- "develop" : equals ``(DeprecationWarning, RuntimeWarning)``
157-
- "release" : equals ``()``, don't raise on any warnings.
156+
- "develop" : equals ``(DeprecationWarning, RuntimeWarning)``
157+
- "release" : equals ``()``, don't raise on any warnings.
158158
159159
Returns
160160
-------

0 commit comments

Comments
 (0)