Breakthrough-Energy / docs

Documentation
https://breakthrough-energy.github.io/docs/
Creative Commons Attribution 4.0 International
13 stars 14 forks source link

Run in parallel and pass build flags from host env #5

Closed jenhagg closed 4 years ago

jenhagg commented 4 years ago

Purpose

Few misc improvements I've been testing out. One is running the builds in parallel, which speeds things up, though I'm not sure if there is a race condition in the html generation, as it's been working well so far. Also formatted conf.py, fixed a couple warnings, and added build flags to tox.ini which may or may not be useful (more on this below).

What it does

Commenting out the html_static_path since we don't have custom css fixes one warning, and upgrading pip in the docker image is one more. The LD and CPP build flags are now passed from the local environment if they exist, but the result is confusing - I still have warnings about the ssl lib, but my docs appear to be fine, (even after deleting the html and rst files before a tox run). Either way, it doesn't seem to affect the docker or github build, so should be safe. The parallel invocation is set to auto which I think limits the degree to number of cores, which I expect will work fine in any of our use cases (local tox, docker, github).

Time to review

5 min - nothing very significant, mostly want to get feedback if this actually works for others, and via testing through github