Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Travis-CI for sphinx-build and linkcheck #17

Merged
merged 1 commit into from Jun 17, 2019

Conversation

AyanSinhaMahapatra
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra commented Jun 12, 2019

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

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
Copy link
Member Author

@AyanSinhaMahapatra AyanSinhaMahapatra commented Jun 12, 2019

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.

@DennisClark DennisClark requested a review from steven-esser Jun 12, 2019
Copy link
Member

@steven-esser steven-esser left a 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
Copy link
Member

@steven-esser steven-esser Jun 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@AyanSinhaMahapatra AyanSinhaMahapatra Jun 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@majurg I activated Travis-CI for my fork of aboutcode and yes the build passed. Check my build here. Also, sphinx-build checks for syntactical errors, and other common errors (the makefile also does the same), I double checked myself again locally by inserting common/complex errors and it works.

Copy link
Member Author

@AyanSinhaMahapatra AyanSinhaMahapatra Jun 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm working on more tests and what can be done (linting and setting standards), this is just some basic tests.

Copy link
Member

@steven-esser steven-esser Jun 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok should I wait to merge this then or do you wish to add those changes later?

Copy link
Member Author

@AyanSinhaMahapatra AyanSinhaMahapatra Jun 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, you need not wait to merge this PR. I'll add those in a separate PR later.

@steven-esser steven-esser merged commit 614ece9 into nexB:master Jun 17, 2019
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants