search

mozilla-services / python-dockerflow

A Python package to implement tools and helpers for Mozilla Dockerflow
https://python-dockerflow.readthedocs.io
Mozilla Public License 2.0
38 stars 22 forks source link

Fix docs build by using autoclass directly #43

Closed jwhitlock closed 4 years ago

jwhitlock commented 4 years ago

The Sphinx directive automodule loads the module in a way that triggers a Flask exception:

RuntimeError: Working outside of application context.

Instead, use autoclass to document the two classes in dockerflow.flask.app directly.

codecov-io commented 4 years ago

Codecov Report

Merging #43 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #43   +/-   ##
=======================================
  Coverage   98.80%   98.80%           
=======================================
  Files          19       19           
  Lines         587      587           
  Branches       79       79           
=======================================
  Hits          580      580           
  Misses          6        6           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 6cc0662...8fb4ea7. Read the comment docs.

jwhitlock commented 4 years ago

It appears this is a bug with Sphinx v3.0.2, we should instead wait for v3.0.3 (and maybe pin Sphinx versions)