Adds Travis-CI for sphinx-build and linkcheck #17
Conversation
This adds test scripts to check build status of Spinx Documentation along with adding checks for broken links. Also fixes some broken links and updates doc_maintenance.rst Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
AyanSinhaMahapatra
force-pushed
the
master
branch
from
59ac634 to
70cc71c
Compare
|
Hi, @DennisClark you'd have to activate Travis-CI for this repository and turn on the "Build Pushed Pull Request" after merging this PR. Builds passed on my forked repository, though first, it gave errors on a lot of broken links and other stuff, which had to be corrected. I have also updated the doc_maintenance.rst on how to run the build tests locally. Additionally, you could add the "Build-Status" badge for this repository. |
There was a problem hiding this comment.
@AyanSinhaMahapatra Have you tested with Travis CI yourself? Just wondering since I cannot see the results until this is merged and I create a Travis CI instance for our repo.
| # halt script on error | ||
| set -e | ||
| # Build locally, and then check links | ||
| sphinx-build -E -W -b linkcheck source build |
There was a problem hiding this comment.
is there more sphinx can check here besides linkcheck? Or will any syntax errors be caught at the build step itself (sphinx-build)?
This needs to be clarified.
There was a problem hiding this comment.
There was a problem hiding this comment.
I'm working on more tests and what can be done (linting and setting standards), this is just some basic tests.
There was a problem hiding this comment.
Ok should I wait to merge this then or do you wish to add those changes later?
There was a problem hiding this comment.
No, you need not wait to merge this PR. I'll add those in a separate PR later.
This adds test scripts to check build status of Spinx Documentation along with adding checks for broken links. Also fixes some broken links and updates doc_maintenance.rst
Signed-off-by: Ayan Sinha Mahapatra ayansmahapatra@gmail.com