Documentation fixes - Githubissues

CMakePP / CMakePPLang

Object-oriented extension to the CMake language.

http://cmakepp.github.io/CMakePPLang/

Apache License 2.0

11 stars 4 forks source link

Documentation fixes #38

Closed zachcran closed 2 years ago

zachcran commented 2 years ago

This PR will:

be where I will put any fixes I make to the documentation while I work through the tutorials to learn how to use CMakePPLang
also close #28, since I will be watching for those naming distinctions as I work my way through the documentation
move code snippets into the tests/docs directory and include them with the literalinclude directive (see here)

ryanmrichard commented 2 years ago

FTR I'd try to preserve to docs/source structure in the tests/docs directory, so something like tests/docs/source/getting_started/cmakepp_examples/classes.cmake (if you put all the snippets in one file) or tests/docs/source/getting_started/cmakepp_exmples/classes/descriptive_name_for_snippet1.cmake (if you want/need multiple files)

zachcran commented 2 years ago

@ryanmrichard I think this PR is r2g!