add sphinx guides builds, warnings
mheppler opened this issue · comments
It would be super neat if the guides were automatically built when a PR is submitted, and any issues like "WARNING: Unknown target name..." get automatically reported to said PR.
Currently these warnings are only caught when the guides are manually built, with an eye watching the output...
$ make html
sphinx-build -b html -d build/doctrees source build/html
Running Sphinx v1.8.2
making output directory...
loading intersphinx inventory from http://docs.python.org/objects.inv...
intersphinx inventory has moved: http://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 97 source files that are out of date
updating environment: 97 added, 0 changed, 0 removed
reading sources... [100%] versions
.../dataverse/doc/sphinx-guides/source/developers/testing.rst:140: WARNING: Unknown target name: "dataverse-ansible repo<https://github.com/globaldataversecommunityconsortium/dataverse-ansible/>".
.../dataverse/doc/sphinx-guides/source/developers/testing.rst:142: WARNING: Unknown target name: "ec2-create-instance.sh<https://raw.githubusercontent.com/globaldataversecommunityconsortium/dataverse-ansible/master/ec2/ec2-create-instance.sh>".
.../dataverse/doc/sphinx-guides/source/developers/testing.rst:143: WARNING: Unknown target name: "main.yml<https://raw.githubusercontent.com/globaldataversecommunityconsortium/dataverse-ansible/master/defaults/main.yml>".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] versions
generating indices... genindex
writing additional pages... search
copying images... [100%] installation/./img/tworavens_test_file_ingested.png
copying downloadable files... [100%] _static/installation/files/etc/shibboleth/attribute-map_adfs.xml
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 3 warnings.
The HTML pages are in build/html.
I think I did this. Vote to close?
@donsizemore works great! Thank you! Closing!