Our organization wants to experiment using devdocs.io to integrate our API documents. I installed devdocs.io locally and ran it in my browser. I:
$ thor list assets ------ thor assets:clean [--keep=<n>] [--verbose] # Clean old assets thor assets:compile [--clean] [--keep=<n>] [--verbose] # Compile all assets console ------- thor console: # Start a REPL thor console:docs # Start a REPL in the "Docs" module docs ---- thor docs:clean # Delete documentation packages thor docs:download (<doc> <doc>... | --all) # Download documentations thor docs:generate <doc> [--verbose] [--debug] [--force] # Generate a documentation thor docs:list # List available documentations thor docs:manifest # Create the manifest thor docs:package (<doc> <doc>... | --all) # Package documentations thor docs:page <doc> [path] [--verbose] [--debug] # Generate a page (no indexing) test ---- thor test:all # Run all tests
which seems to indicate that you are making accurate documents: generate and pass a "doc". What is a document? The path to the file? URL? Name? If I pass the url, then it seems like I'm trying to execute a subcommand:
$ thor docs:generate http://host/path/to/resource devdocs/lib/docs.rb:40:in `const_get': wrong constant name Http:::::::::HOST::Path::To::Resource:: (NameError)
What's up with that? Do I have to register the name of the documents that I generate somewhere and give them that name? Basic documentation of how this will be really useful. I did not see. Maybe I just skipped it somewhere, but I really searched the Internet and read the README.md file on github.
Aaron source share