canonical / charms.reactive

Framework for developing charms and relations using the reactive pattern
Apache License 2.0
22 stars 34 forks source link

`make docs` is broken due to changes in dependencies #256

Open ajkavanagh opened 5 months ago

ajkavanagh commented 5 months ago

Run make doc and watch failures.

Also relevant is that docutils needs an update: #253

Many issues are https://github.com/sphinx-doc/sphinx/issues/7747 and:

Exception occurred:
  File "/home/alex/Projects/Canonical/git/github.com/juju-solutions/charms.reactive/docs/_extensions/automembersummary.py", line 47, in _get_items
    if self.result.data and ".. deprecated::" in self.result.data[0]:
AttributeError: 'AutoMemberSummary' object has no attribute 'result'

which is really due to:

docs/_extensions/automembersummary.py
26:class AutoMemberSummary(Autosummary):
46:            _items = super(AutoMemberSummary, self).get_items([shorten + name])
91:    app.add_directive('automembersummary', AutoMemberSummary)

i.e. the docs generation needs some updating.