Docs workflow test

[chkim-usgs]

Pushes to s3://asc-public-docs

[acpaquette]

@chkim-usgs Python 3.6 and 3.7 are no longer supported. Can we updated the python versions in the CI python version matrix to [3.8, 3.9, 3.10, 3.11]?

[Kelvinrr]

Can we get the readme updated with instructions to build the docs. Currently I am getting:

Theme error:
An error happened in rendering the page developers/index.
Reason: UndefinedError("'style' is undefined")

trying to build locally. Maybe a missing dep?

[chkim-usgs]

@Kelvinrr If you create a conda environment with the docs yaml environment_docs.yaml, the docs should build properly. I can update the environment.yml to support docs build and the readme as well.

[Kelvinrr]

@chkim-usgs That did it thanks, must have missed that file. It looks good, there are some weird formatting things but I think those probably existed before and most likely not your problem to solve.

One thing worth adding as it's related to the footers. Is some CSS along the lines of

.bodywrapper {
    min-height: 100vh;
}

Which is an easy way to force the footer to the bottom one smaller pages on the site. There is some stuff in the custom.css to do this but the docs setup here is a little weird. You can probably add it to the already existing CSS. That + the readme update and I think this is good to go.

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@98206cc). Click here to learn what that means.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@           Coverage Diff           @@
##             main     #198   +/-   ##
=======================================
  Coverage        ?   53.38%           
=======================================
  Files           ?       35           
  Lines           ?     2377           
  Branches        ?        0           
=======================================
  Hits            ?     1269           
  Misses          ?     1108           
  Partials        ?        0           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

📢 Have feedback on the report? Share it here.

[Kelvinrr]

Sorry, premature approve, this needs to be environment_docs.yml

[chkim-usgs]

I actually updated the environment.yml file to support docs build (just added sphinx dep), should I revert that?

[Kelvinrr]

is it enough to completely build the docs? Pretty sure you need all the docs deps to build it not just sphinx-build command. I manually installed sphinx earlier and ended up with that error from before.

[chkim-usgs]

Oh hm, I tested it out by creating a new conda env with the updated yaml file and ran the sphinx-build command without issue. Also, I did have to pin the sphinx version to 6.2.1 so if you did a casual conda install sphinx, it may have installed a version (7.0+) that is known to cause the error you ran into.

[Kelvinrr]

yeah that seemed to be the issue. I assumed there was other stuff needed for the themes and such and I guess in my rampant context switching I missed that this has the theme locally.