Documentation warnings

[Zethson]

WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT": name 'Vocab' is not defined
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.create_vocabulary": name 'Vocab' is not defined
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.load_concept_db": name 'CDB' is not defined
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.load_vocabulary": name 'Vocab' is not defined
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.save_vocabulary": name 'Vocab' is not defined
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.update_cat": name 'Vocab' is not defined
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.update_cat_config": name 'Config' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:48: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.create_vocabulary": name 'Vocab' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:52: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.load_concept_db": name 'CDB' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:56: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.load_vocabulary": name 'Vocab' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:60: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:64: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:68: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.save_vocabulary": name 'Vocab' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:72: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:76: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.update_cat": name 'Vocab' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.MedCAT.rst:80: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT.update_cat_config": name 'Config' is not defined
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.Translator.rst:42: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.Translator.rst:46: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/zeth/PycharmProjects/ehrapy/docs/usage/tools/ehrapy.tools.Translator.rst:50: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: Cannot resolve forward reference in type annotations of "ehrapy.tools.MedCAT": name 'Vocab' is not defined

Think that these could be solved with smarter imports.

[eroell]

Maybe a naive question, what are the reasons to not add medcat to the doc-dependencies list?

[Zethson]

I don't think that this is a naive question at all. medcat is faaaaaat and I didn't want everyone to have to install it...

[eroell]

Would it make sense to add it for people that intend to build the docs? (just to make sure, a user install does not by default install the doc requirements right)
From a first thought, these people likely

• are not the majority
• are involved enough to accept some heavy packages
• might consider error messages everytime when building the doc a larger nuisance than a 1x install

What are your thoughts on this?

[Zethson]

Yeah, I probably agree. It pains me, but it is for the better :)