You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
During investigation of #111 I found that Sphinx currently throws a number of warnings related to the use of the :ref: role in the Python function docstrings. Some examples:
and originally defined as class GeoMapping() in bw2data/meta.py.
In this case: We should investigate if/how Sphinx can work with aliases of this nature (this is actually related to the larger discussion here: #83 (comment)).
In this case: Since serialized-dictis used only once in bw2data and only in a docstring, it seems that it was never aliased to SerializedDict.
We should clear this up because:
I didn't find a way to suppress the Sphinx warnings related to broken :ref: use.
I don't want to find a way to suppress the Sphinx warnings related to broken :ref: use, since this would likely disallow for the planned use of the linkcheck builder: Check for Dead Links #95
The number of bad uses of :ref: is limited in scope.
The text was updated successfully, but these errors were encountered:
During investigation of #111 I found that Sphinx currently throws a number of warnings related to the use of the
:ref:
role in the Python function docstrings. Some examples:I investigated two cases:
geomapping
The
:ref:
that throws the error is used inclass ProcessedDataStore
inbw2data/data_store.py
:aliased at
bw2data/meta.py
:and originally defined as
class GeoMapping()
inbw2data/meta.py
.In this case: We should investigate if/how Sphinx can work with aliases of this nature (this is actually related to the larger discussion here: #83 (comment)).
serialized-dict
The
:ref:
that throws the error is used inclass DataStore
inbw2data/data_store.py
:and originally defined as
class SerializedDict()
inbw2data/serialization.py
.In this case: Since
serialized-dict
is used only once inbw2data
and only in a docstring, it seems that it was never aliased toSerializedDict
.We should clear this up because:
:ref:
use.:ref:
use, since this would likely disallow for the planned use of thelinkcheck
builder: Check for Dead Links #95:ref:
is limited in scope.The text was updated successfully, but these errors were encountered: