Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Feature Request] Turn off documentation with flag #41

Closed
anders-wind opened this issue Jan 3, 2022 · 3 comments
Closed

[Feature Request] Turn off documentation with flag #41

anders-wind opened this issue Jan 3, 2022 · 3 comments
Labels
docs Issues related to Doxygen and m.css in generated projects

Comments

@anders-wind
Copy link
Contributor

anders-wind commented Jan 3, 2022 •
edited
Loading

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 :)
@anders-wind anders-wind changed the title Turn off documentation with flag [Feature Request] Turn off documentation with flag Jan 3, 2022
@friendlyanon
Copy link
Owner

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.

@anders-wind
Copy link
Contributor Author

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.

friendlyanon added a commit that referenced this issue Jan 20, 2022
@friendlyanon
Add a separate docs script for CI
c7ee6cf 
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.
@friendlyanon friendlyanon mentioned this issue Feb 20, 2022
Open
friendlyanon added a commit that referenced this issue Feb 20, 2022
@friendlyanon
Add note about Doxygen version requirement
2548538 
m.css does not work with Doxygen >= 1.9

Issues: #41, #48
@friendlyanon friendlyanon added the docs Issues related to Doxygen and m.css in generated projects label May 26, 2022
@friendlyanon
Copy link
Owner

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Issues related to Doxygen and m.css in generated projects
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@friendlyanon @anders-wind