Documentation bug fixes and Sphinx refactor (replace stray Python/.txt with ..literalinclude)

mtwichan commented 4 years ago

Issue: https://github.com/convexengineering/gpkit/issues/1280 : make sure all code in docs is in a running example (#303)

Replaced all stray python/.txt code with their own separate files. See: https://github.com/mtwichan/gpkit/commit/7560094a1bf467132843654e2e562a177173da66#diff-570a5dc3719d98db8c8df4e9a3f5b63aL15-R15
Fixed a couple print statements that were missing their brackets (python2 artifacts) Ex: https://github.com/mtwichan/gpkit/commit/7560094a1bf467132843654e2e562a177173da66#diff-741b3f2f01574abb85dd461cb2bba89cL19
Very minor spelling/grammar fixes.
Bug Fix: https://github.com/mtwichan/gpkit/commit/7560094a1bf467132843654e2e562a177173da66#diff-52397748fa667e06aba5e880d7a597e6L90-R70

Status:

Currently, I am naively running all python files in the examples folders and tackling files containing errors.

CC: @bqpd

acdl-jenkins commented 4 years ago

Can one of the admins verify this patch?

bqpd commented 4 years ago

add to whitelist

bqpd commented 4 years ago

this is fabulous! looks like the linting of examples is throwing a fit, while the unit tests are failing because not all files in the examples directory now run individually. Will do a full code review soon!

1ozturkbe commented 4 years ago

This all looks great! Super amped to have the documentation up to date and tested!

mtwichan commented 4 years ago

Transfer PR to: https://github.com/convexengineering/gpkit/pull/1509

convexengineering / gpkit

Documentation bug fixes and Sphinx refactor (replace stray Python/.txt with ..literalinclude) #1508