Update CI including sphinx for documentation #124
Conversation
| - ~/.bundle | ||
| - ~/.go_workspace | ||
| - ~/.gradle | ||
| - ~/.cache/bower |
There was a problem hiding this comment.
This cache is not needed for python. In particular, no virtualenv used here.
| @@ -34,7 +34,7 @@ class ExampleReportBuilder(object): | |||
| def build(pvarray): | |||
| """Method that will build the simulation report. Here we're using the | |||
| previously defined | |||
| :py:function:`~pvfactors.report.example_fn_build_report`. | |||
| :py:func:`~pvfactors.report.example_fn_build_report`. | |||
There was a problem hiding this comment.
This typo generates a warning, but is not actually included in the doc'n.
There was a problem hiding this comment.
Maybe this method should be included in the docs? Not sure if that would be helpful.
There was a problem hiding this comment.
Updated to have link in first sentence, which is the only one Sphinx includes in the doc'n.
| @@ -265,7 +265,7 @@ def _run_serially(args): | |||
| ---------- | |||
| args : tuple | |||
| List of arguments where most will be used in | |||
| :py:function:`~pvfactors.run.run_timeseries_engine` | |||
| :py:func:`~pvfactors.run.run_timeseries_engine` | |||
There was a problem hiding this comment.
This typo generates a warning, but is not actually included in the doc'n.
|
@kanderso-nrel I couldn't add you as an official reviewer, but I would appreciate your informal review. Thanks. |
|
I think I was mistaken about visibility here. Reopening. |
| - ~/.gradle | ||
| - ~/.cache/bower | ||
| - run: pytest | ||
| - run: pytest --junitxml=$CIRCLE_TEST_REPORTS/junit.xml | ||
| - store_test_results: | ||
| path: /tmp/circleci-test-results | ||
| - store_artifacts: | ||
| path: /tmp/circleci-artifacts |
There was a problem hiding this comment.
Not a big deal, but I think this entry might not be doing anything:
Uploading /tmp/circleci-artifacts to tmp/circleci-artifacts
No artifact files found at /tmp/circleci-artifacts
Total size uploaded: 0 B
There was a problem hiding this comment.
I noticed this and left it in for now because I'm not sure if something is supposed to be saved there, say for uploads to pypi. Sorry that I didn't add a comment.
| @@ -34,7 +34,7 @@ class ExampleReportBuilder(object): | |||
| def build(pvarray): | |||
| """Method that will build the simulation report. Here we're using the | |||
| previously defined | |||
| :py:function:`~pvfactors.report.example_fn_build_report`. | |||
| :py:func:`~pvfactors.report.example_fn_build_report`. | |||
There was a problem hiding this comment.
Maybe this method should be included in the docs? Not sure if that would be helpful.
@kanderso-nrel pointed out some issues in #122 with CircleCI builds, which are addressed here. I also hardened and cleaned up the builds, including better reporting of the test results/artifacts.
Followup work will be reviewing/improving automation on tagged releases, including Github artifacts, documentation, and pypi publishing.