libgit2 / docurium

Doxygen replacement for the libgit2 project
http://libgit2.github.com/libgit2
MIT License
158 stars 25 forks source link

Fails with: You need to specify a valid config file, when using generated template. #11

Closed noname22 closed 11 years ago

noname22 commented 11 years ago

I generated a very basic api.docurium file using cm gen and changed it to match my project setup. When I try to generate documentation cm instantly fails with cryptic output as to what's wrong.

This is on Ubuntu 13.04 with ruby 1.9.3p194 and cm 0.2.1.

noname@noname:~/git/OpenHMD$ cm doc api.docurium
WARNING: Pygments not found. Using webservice.
You need to specify a valid config file
/var/lib/gems/1.9.1/gems/docurium-0.2.1/lib/docurium.rb:17:in `initialize'
/var/lib/gems/1.9.1/gems/docurium-0.2.1/lib/docurium/cli.rb:5:in `new'
/var/lib/gems/1.9.1/gems/docurium-0.2.1/lib/docurium/cli.rb:5:in `doc'
/var/lib/gems/1.9.1/gems/docurium-0.2.1/bin/cm:18:in `block (2 levels) in <top (required)>'
/var/lib/gems/1.9.1/gems/gli-2.7.0/lib/gli/command_support.rb:121:in `call'
/var/lib/gems/1.9.1/gems/gli-2.7.0/lib/gli/command_support.rb:121:in `execute'
/var/lib/gems/1.9.1/gems/gli-2.7.0/lib/gli/app_support.rb:279:in `block in call_command'
/var/lib/gems/1.9.1/gems/gli-2.7.0/lib/gli/app_support.rb:292:in `call'
/var/lib/gems/1.9.1/gems/gli-2.7.0/lib/gli/app_support.rb:292:in `call_command'
/var/lib/gems/1.9.1/gems/gli-2.7.0/lib/gli/app_support.rb:79:in `run'
/var/lib/gems/1.9.1/gems/docurium-0.2.1/bin/cm:41:in `<top (required)>'
/usr/local/bin/cm:23:in `load'
/usr/local/bin/cm:23:in `<main>'
noname@noname:~/git/OpenHMD$ cat api.docurium
{
 "name":   "OpenHMD",
 "github": "OpenHMD/OpenHMD",
 "input":  "include",
 "prefix": "ohmd_",
 "output": "docs"
}
noname@noname:~/git/OpenHMD$ ls include/
openhmd.h
tmc commented 11 years ago

This project moved to only building to a branch but didn't update documentation or code or default generated config. Change your 'output' to 'branch' and 'cm doc' will put commit new docs on that branch.

noname22 commented 11 years ago

How... inconvenient. We have a separate repository for the web page, so generating the documentation to a branch of the library repo doesn't really make much sense. Not too hard to work around the issue though.

Thanks for helping out!