Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
CodeDocs is like continuous integration for your documentation: with every commit, your documentation is generated and anyone can see it at
https://codedocs.xyz/UsernameOrOrg/RepoName. Documentation is generated with Doxygen, but by default CodeDocs does not look for any existing doxyfile you may have. Configuration is done via a
.codedocs file in the root of your repository.
.codedocs file is similar to a doxyfile, but only a subset of options are whitelisted, along with some special options unique to CodeDocs. All options are specified in the format
VAR_NAME = value/or/path, and backslashes can escape newlines to span multiple lines.
These Doxygen options are whitelisted (and possibly others):
Below are options unique to CodeDocs.
If you have an existing doxyfile that you would like to use, set this variable to the relative path to it. You can override the values in the doxyfile with values in the
If you have multiple repositories and need to cross link documentation, you can specify the repositories here in the form
UsernameOrOrg/RepoName and CodeDocs will include the doxygen tag files.