Is it good practice to include and commit the Doxygen HTML documentation for my project in the SVN repository?
Share
Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
Is it good practice to include and commit the Doxygen HTML documentation for my project in the SVN repository?
I’d tend to say no since the docs are generated stuff.
While there might be cases where this could be useful (e.g. when releasing a version that contains the docs) in general, generated content should be kept out of the VCS.
Versioning the docs would only make sense if you generate the docs freshly before each commit (which in my experience is usually not done). Otherwise, there might be the case that the generated documentation doesn’t match the actual code.
Version the
doxyfile.dox(where you store your generation settings) instead. If you distribute the settings, you could generate the documentation on-the-fly during installation of your project.