datacamp / shellwhat

https://shellwhat.readthedocs.io
GNU Affero General Public License v3.0
2 stars 8 forks source link

update mocks to fix docs #33

Closed machow closed 6 years ago

machow commented 6 years ago

@gvwilson just a note, readthedocs (where shellwhat docs are hosted) doesn't need to have any package dependencies installed. Rather, packages are mocked in the sphinx config. The docs in this case were failing to build because I had shellwhat start using a new set of SCTs from protowhat (protowhat.checks.check_files), but didn't mock that module for the shellwhat docs.

(all of this is to say that, and you are going to love this, the way sphinx autodocuments requires running the code being documented ;)