search

pycontribs / ruyaml

ruyaml is a openly maintained fork of elusive ruamel-yaml package that can be used as as a drop-in replacement.
https://pypi.org/project/ruyaml/
MIT License
73 stars 15 forks source link

Add automatically generated API to documentation in https://ruyaml.readthedocs.io #52

Open mauvilsa opened 3 years ago

mauvilsa commented 3 years ago

It would be very useful if the API automatically generated using sphinx's autodoc is included in the documentation of readthedocs. If I understand correctly this was actually the plan (https://github.com/pycontribs/ruyaml/issues/1#issuecomment-716967334). Still I think it is good to have a github issue requesting this.

Just for reference. I am considering the use of ruyaml to generate a yaml with comments (https://github.com/omni-us/jsonargparse/issues/52). But the methods that can be used to add comments are not documented. There is only one example in the documentation which only mentions yaml_add_eol_comment but there is no way to know what other methods there are or the parameters they receive and their descriptions.

funkyfuture commented 2 years ago

indeed i was very suprised that this (or rather the origin) so popular package has such a, excuse my dutch, shitty documentation. it would be most helpful not only to add API docs, but also to get rid of all the contents with elaborations about a previous API and whatnot anecdotes.