-
Notifications
You must be signed in to change notification settings - Fork 79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature Request] Turn off documentation with flag #41
Comments
The docs code is already optional ( 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. |
This script will fetch m.css on its own and parse the project() call out of the top level CML for its arguments. This solution is a bit messy still. One idea to improve this would be to create the docs artifacts in one of the CI runs and then use those in the publishing job. This falls apart when the publishing is run on the master branch only, like one of the example cmake-init projects. There, the testing is done on the develop branch and the GH pages is populated with docs generated on pushes to the master branch. Kind of related issue: #41 This space could use improvements.
I'll close this, since the title is satisfied by the |
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 text was updated successfully, but these errors were encountered: