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
We have this apify SDK package which extends some classes from another package (crawlee). One example is the KeyValueStore class, exported from crawlee, which is extended in the SDK - only this extension is being exported from the SDK package. We have it documented with @inheritDoc but it is not being resolved (you can see the hierarchy is also not clickable - but we do set excludeExternals: false in the typedocOptions):
Not sure if this is a bug in the docusaurus integration or more of a typedoc thing on its own. If I reexport the class from crawlee inside the SDK package, it starts to work (both the @inheritDoc as well as the hierarchy links), but then I have one more class in the docs I don't want to have documented.
The text was updated successfully, but these errors were encountered:
I'll be honest, I'm really not sure. All of the doc inheritance/linking stuff happens on the TypeDoc side. I'd guess that only things exported are actually considered "documentable".
We have this
apify
SDK package which extends some classes from another package (crawlee
). One example is theKeyValueStore
class, exported from crawlee, which is extended in the SDK - only this extension is being exported from the SDK package. We have it documented with@inheritDoc
but it is not being resolved (you can see the hierarchy is also not clickable - but we do setexcludeExternals: false
in thetypedocOptions
):https://sdk.apify.com/api/apify/class/KeyValueStore
https://github.com/apify/apify-sdk-js/blob/master/packages/apify/src/key_value_store.ts
Not sure if this is a bug in the docusaurus integration or more of a typedoc thing on its own. If I reexport the class from crawlee inside the SDK package, it starts to work (both the
@inheritDoc
as well as the hierarchy links), but then I have one more class in the docs I don't want to have documented.The text was updated successfully, but these errors were encountered: