NSLS-II-SIX / sixtools

Software for performing resonant inelastic xray scattering analysis at NSLS-II
https://pypi.org/project/sixtools
Other
1 stars 2 forks source link

Attempt to have docs autogenerate and deploy to webpage #7

Closed awalter-bnl closed 5 years ago

awalter-bnl commented 5 years ago

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.

codecov-io commented 5 years ago

Codecov Report

Merging #7 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master       #7   +/-   ##
=======================================
  Coverage   43.26%   43.26%           
=======================================
  Files           3        3           
  Lines         282      282           
=======================================
  Hits          122      122           
  Misses        160      160

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b5159a3...f27c575. Read the comment docs.

awalter-bnl commented 5 years ago

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.

awalter-bnl commented 5 years ago

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