yaml-cpp icon indicating copy to clipboard operation
yaml-cpp copied to clipboard

Published 20 hours ago • verified publisher icon jbeder

Documentation with API reference

Open erez-o opened this issue 3 years ago • 4 comments

Hi,

I've created a documentation with API reference, you can see it at https://yaml-cpp.docsforge.com/

Hope it's helpful for anyone using yaml-cpp. The docs are built automatically every week so they should always be in sync with the code and wiki docs.

If there are any more tutorial pages you wish to add to the sidebar, or you wish to hide certain internal APIs from being displayed please let me know, everything is configurable using a simple yaml configuration file. I can transfer ownership and you can configure everything.

Disclaimer - I'm the creator of docsforge, free service for open source projects.

erez-o avatar Aug 11 '20 08:08 erez-o

This doc is just a copy of what is in this repo right? Does it add any additional examples?

RajaSrinivasan avatar Sep 27 '20 09:09 RajaSrinivasan

Yes, it's only derived from what's inside the repo with api references.

erez-o avatar Sep 27 '20 11:09 erez-o

Thank you for that. It's actually more helpful than the original documentation, although it has the same source. :+1:

acwn1976 avatar Dec 17 '20 21:12 acwn1976

this is far more usefull as it excludes the googletest namespace/classes

L0ric0 avatar Apr 01 '21 18:04 L0ric0