Commit fa45a97b authored by Nikita Titov's avatar Nikita Titov Committed by GitHub
Browse files

[docs] added validation of rst-files into python-package folder (#998)

* added validation of python-package folder

* fixed duplicate explicit targets names
parent a668045e
...@@ -26,9 +26,11 @@ esac ...@@ -26,9 +26,11 @@ esac
cd $TRAVIS_BUILD_DIR cd $TRAVIS_BUILD_DIR
if [[ ${TASK} == "check-docs" ]]; then if [[ ${TASK} == "check-docs" ]]; then
cd docs
sudo apt-get install linkchecker sudo apt-get install linkchecker
pip install rstcheck sphinx sphinx_rtd_theme # html5validator pip install rstcheck sphinx sphinx_rtd_theme # html5validator
cd python-package
rstcheck --report warning `find . -type f -name "*.rst"` || exit -1
cd ../docs
rstcheck --report warning --ignore-directives=autoclass,autofunction `find . -type f -name "*.rst"` || exit -1 rstcheck --report warning --ignore-directives=autoclass,autofunction `find . -type f -name "*.rst"` || exit -1
make html || exit -1 make html || exit -1
find ./_build/html/ -type f -name '*.html' -exec \ find ./_build/html/ -type f -name '*.html' -exec \
......
...@@ -11,7 +11,7 @@ Preparation ...@@ -11,7 +11,7 @@ Preparation
`setuptools <https://pypi.python.org/pypi/setuptools>`_ is needed. `setuptools <https://pypi.python.org/pypi/setuptools>`_ is needed.
For Mac OS X users, gcc with OpenMP support must be installed first. Refer to `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#osx>`_ for installing gcc with OpenMP support. For Mac OS X users, gcc with OpenMP support must be installed first. Refer to `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#osx>`__ for installing gcc with OpenMP support.
Note: 32-bit Python is not supported. Please install 64-bit version. Note: 32-bit Python is not supported. Please install 64-bit version.
...@@ -47,7 +47,7 @@ Build GPU Version ...@@ -47,7 +47,7 @@ Build GPU Version
For Windows users, `CMake <https://cmake.org/>`_ (version 3.8 or higher) is strongly required in this case. For Windows users, `CMake <https://cmake.org/>`_ (version 3.8 or higher) is strongly required in this case.
Note: Boost and OpenCL are needed: details for installation can be found in `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version>`_. You need to add ``OpenCL_INCLUDE_DIR`` to the environmental variable **'PATH'** and export ``BOOST_ROOT`` before installation. Note: Boost and OpenCL are needed: details for installation can be found in `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version>`__. You need to add ``OpenCL_INCLUDE_DIR`` to the environmental variable **'PATH'** and export ``BOOST_ROOT`` before installation.
Build with MinGW-w64 on Windows Build with MinGW-w64 on Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...@@ -76,9 +76,9 @@ Note: ``sudo`` (or administrator rights in Windows) may be needed to perform the ...@@ -76,9 +76,9 @@ Note: ``sudo`` (or administrator rights in Windows) may be needed to perform the
Run ``python setup.py install --mingw`` if you want to use MinGW-w64 on Windows instead of Visual Studio. `CMake <https://cmake.org/>`_ and `MinGW-w64 <https://mingw-w64.org/>`_ should be installed first. Run ``python setup.py install --mingw`` if you want to use MinGW-w64 on Windows instead of Visual Studio. `CMake <https://cmake.org/>`_ and `MinGW-w64 <https://mingw-w64.org/>`_ should be installed first.
Run ``python setup.py install --gpu`` to enable GPU support. For Windows users, `CMake <https://cmake.org/>`_ (version 3.8 or higher) is strongly required in this case. Boost and OpenCL are needed: details for installation can be found in `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version>`_. Run ``python setup.py install --gpu`` to enable GPU support. For Windows users, `CMake <https://cmake.org/>`_ (version 3.8 or higher) is strongly required in this case. Boost and OpenCL are needed: details for installation can be found in `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version>`__.
If you get any errors during installation or due to any other reason, you may want to build dynamic library from sources by any method you prefer (see `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst>`_) and then run ``python setup.py install --precompile``. If you get any errors during installation or due to any other reason, you may want to build dynamic library from sources by any method you prefer (see `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst>`__) and then run ``python setup.py install --precompile``.
Examples Examples
-------- --------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment