Attempt to have docs autogenerate and deploy to webpage#7
Conversation
Codecov Report
@@ Coverage Diff @@
## master #7 +/- ##
=======================================
Coverage 43.26% 43.26%
=======================================
Files 3 3
Lines 282 282
=======================================
Hits 122 122
Misses 160 160Continue to review full report at Codecov.
|
|
In this PR I am attempting to have the docs for NSLS-II-SIX/sixtools autogenerate the docs and publish them to a webpage. I attempted to use the instructions here and the .travis.yaml file in NSLS-II/bluesky as an example. Any feedback on what I did wrong is appreciated. |
| - coverage report -m # Generate test coverage report. | ||
| - codecov # Upload the report to codecov. | ||
| - flake8 --max-line-length=115 # Enforce code style (but relax line length limit a bit). | ||
| - make -C docs html # Build the documentation. |
There was a problem hiding this comment.
You can leave this line as it was and just add set -e and doctor deploy ... The $BUILD_DOCS stuff is an old pattern that I would no longer recommend.
| make html | ||
| popd | ||
| #publish docs | ||
| doctr deploy --deploy-repo NSLS-II-SIX/NSLS-II-SIX.github.io --deploy-branch-name master sixtools |
There was a problem hiding this comment.
This --deploy-repo NSLS-II-SIX/NSLS-II-SIX.github.io --deploy-branch-name master customization (incidentally, added by me -- see PR for context on what this is doing) isn't necessary unless we want to go the route of one centralized target for built artifacts. We do that for NSLS-II/* repos, but it probably is overkills for SIX.
|
Thanks for the review @danielballan, and the description of why using the NSLS-II approach is not needed here. I have made the suggested changes |
| - set -e # Stop here if anything fails above | ||
| - make -C docs html # Build the documentation | ||
| - pip install doctr | ||
| - doctr deploy --built-docs docs/build/html # Publish the documentation |
There was a problem hiding this comment.
Travis failed because this is missing the target directory to deploy the HTML into. Add ..
- doctr deploy --built-docs docs/build/html . # Publish the documentationAdding the root directory `.` to the end
3 participants
Add auto-generation and publication to a website for the documentation. this covers issue #6 and I will duplicate this in scikit-beam/rixs once it is merged here.