search

NPLinker / nplinker

A python framework for data mining microbial natural products by integrating genomics and metabolomics data
https://nplinker.github.io/nplinker
Apache License 2.0
17 stars 13 forks source link

improvement on docs #232

Closed CunliangGeng closed 6 months ago

CunliangGeng commented 7 months ago

Please leave your comments (questions, problems, suggestions, advice, ideas...) below about the doc website https://nplinker.github.io/nplinker/latest/.

CunliangGeng commented 7 months ago

The types of attributes are not displayed since they are documented in __init__ method, which should be supported by mkdocstring-python (see issue https://github.com/mkdocstrings/python/issues/144).

Followup: it won't be supported by mkdocstring-python. So it's necessary to put the attributes docstrings on class level, see example.

Fixed in PR #239