approvals / ApprovalTests.cpp

Native ApprovalTests for C++ on Linux, Mac and Windows
https://approvaltestscpp.readthedocs.io/en/latest/
Apache License 2.0
316 stars 51 forks source link

Provide reference documentation #129

Closed claremacrae closed 4 years ago

claremacrae commented 4 years ago

This is to implement the "Reference" quadrant of Daniele Procida's Documentation System:

https://documentation.divio.com

Sy Brand has documented a series of steps to implement the technical aspects of this for C++ code, to publish library documentation on Read the Docs:

https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

claremacrae commented 4 years ago

There is a starting point available now at:

This is updated every time changes are pushed to GitHub.

The next step is to work out what to show to users, and then to set up a meaningful structure to show it.

claremacrae commented 4 years ago

TODOs:

Note to self: Remember not to change files that have been changed significantly on the Options branch.