Skip to content

Commit

Permalink
Use latest version of sphinx for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
David Goodwin committed Nov 14, 2018
1 parent caef130 commit b144379
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
6 changes: 2 additions & 4 deletions docs/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,11 @@ is based on `Sphinx <http://www.sphinx-doc.org>`_. `Doxygen
<https://github.com/svenevs/exhale>`_ is used for C++ API
docuementation.

To build the docs install the required dependencies. As of 10/22/2018
need to install sphinx version < 1.8 to avoid a bug related to
exhale::
To build the docs install the required dependencies::

$ apt-get update
$ apt-get install -y --no-install-recommends doxygen
$ pip install --upgrade 'sphinx<1.8' sphinx-rtd-theme nbsphinx exhale
$ pip install --upgrade sphinx sphinx-rtd-theme nbsphinx exhale

To get the Python client library API docs the TensorRT Inference
Server Python package must be installed::
Expand Down
5 changes: 1 addition & 4 deletions qa/L0_docs/test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,9 @@ TEST_LOG="./docs.log"
rm -f $TEST_LOG
RET=0

# FIXME. As of 10/22/2018 need to install sphinx version < 1.8 to
# avoid bug related to exhale. But should remove that once bug is
# fixed.
apt-get update && \
apt-get install -y --no-install-recommends doxygen && \
pip install --upgrade 'sphinx<1.8' sphinx-rtd-theme nbsphinx exhale && \
pip install --upgrade sphinx sphinx-rtd-theme nbsphinx exhale && \
pip install --upgrade /opt/tensorrtserver/pip/tensorrtserver-*.whl

set +e
Expand Down

0 comments on commit b144379

Please sign in to comment.