python-igraph icon indicating copy to clipboard operation
python-igraph copied to clipboard

"Unknown fields" in documentation

Open szhorvat opened this issue 4 years ago • 2 comments

Describe the bug

"Unknown field" appears in multiple places in the documentation.

Examples:

image

https://igraph.org/python/doc/api/igraph._igraph.GraphBase.html#community_multilevel

Version information 0.9.1

szhorvat avatar May 28 '21 13:05 szhorvat

This is due to PyDoctor not supporting custom fields from Epytext (in particular, the @newfield directive). We either need to clean these up in the documentation or send a patch to PyDoctor to start supporting custom fields from Epytext. I'm leaning towards the former as it is easier, although the formatting of references would be nicer with the latter.

ntamas avatar May 28 '21 13:05 ntamas

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jul 28 '21 03:07 stale[bot]

Pydoctor issue for this feature: https://github.com/twisted/pydoctor/issues/456

Should be relatively simple to implement ;)

tristanlatr avatar Apr 06 '23 15:04 tristanlatr

I've started cleaning this up in develop.

ntamas avatar Sep 29 '23 13:09 ntamas

Docs cleaned up.

ntamas avatar Sep 29 '23 14:09 ntamas

Awesome job

iosonofabio avatar Sep 29 '23 21:09 iosonofabio