diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..66113b9ca --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +sphinx: + configuration: docs/source/conf.py + +formats: all + +python: + version: "3.7" + install: + - requirements: docs/source/requirements.txt diff --git a/docs/run_doc.sh b/docs/run_doc.sh index ffc61d5d3..d665546ce 100755 --- a/docs/run_doc.sh +++ b/docs/run_doc.sh @@ -11,5 +11,5 @@ bash run_doxygen.sh # Build sphinx docs cd source make clean -make html -make latexpdf +make SPHINXOPTS='-W --keep-going' html +make SPHINXOPTS='-W --keep-going' latexpdf diff --git a/docs/source/api_lapacklike.rst b/docs/source/api_lapacklike.rst index 781e18cd5..32b21d724 100644 --- a/docs/source/api_lapacklike.rst +++ b/docs/source/api_lapacklike.rst @@ -193,7 +193,7 @@ rocsolver_getri_npvt_outofplace_batched() .. doxygenfunction:: rocsolver_sgetri_npvt_outofplace_batched rocsolver_getri_npvt_outofplace_strided_batched() ------------------------------------------------------ +------------------------------------------------------- .. doxygenfunction:: rocsolver_zgetri_npvt_outofplace_strided_batched :outline: .. doxygenfunction:: rocsolver_cgetri_npvt_outofplace_strided_batched diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 8e2066655..1452f25b6 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -1,2 +1,5 @@ - -breathe +docutils==0.16 +sphinx==3.5.3 +sphinx_rtd_theme==0.4.3 +readthedocs_sphinx_ext==2.1.4 +breathe==4.28.0