friendlyanon/cmake-init

[Feature Request] Turn off documentation with flag

anders-wind opened this issue · 3 comments

First of all thanks for the amazing project :)
I have been using cmake-init for my project, and it has been working splendidly.

Would it be possible to get a flag for the generator that removes the docs (--no-docs) functionality (like --no-clang-tidy).
I think it has a couple of benefits if the user. The user might want to roll their own documentation / github wiki etc. Furthermore it would reduce code/files for small simple projects.

I hope it would not be too cumbersome :)

The docs code is already optional (BUILD_MCSS_DOCS) and I value the presence of docs greatly. The code is also relatively minimal and easy to strip/modify.

However, m.css seems to have a weird activity (no commits since may until yesterday) and it has issues with C projects (#12). I also had to apply some pending PRs and additional fixes to work properly for me (ref).

I'm aware that m.css might not be the best tool around, so I would like to know about alternatives to at least consider something else.

That is fair - I tried to remove it and yes it was quite simple. I don't have a better framework for creating documentation in mind. I normally go with github wiki and have scripts for automatically getting regions in the code base.

I'll close this, since the title is satisfied by the BUILD_MCSS_DOCS developer mode cache variable.
Improvements to documentation generation coming soon! (hopefully next year)