Debug options

99% of the time you won't need these advanced options. This is only for people who want more flexibility.

-- doxygen specific settings
doxygen_filetypes = { 'c', 'cpp', 'cs', 'python', 'd', 'fortran', 'java', 'perl', 'vhdl', 'objc', 'php' } -- for this filetypes use doxygen
doxygen_docs_dir = "doxygen"                                                     -- the doxigen dir.
doxygen_html_file = "html/index.html"                                            -- html file to open with :DookuOpen. This path starts in doxygen_docs_dir, instead of the root directory.
doxygen_clone_config_repo = "https://github.com/Zeioth/vim-doxygen-template.git" -- repo to clone if auto_setup.
doxygen_clone_to_dir = "doxygen"                                                 -- clone into this dir.
doxygen_clone_cmd_post = ""                                                      -- runs a command after cloning.
doxygen_cmd = { "doxygen Doxyfile" }                                             -- command to run doxygen.

-- typedoc specific settings
typedoc_filetypes = { "typescript" }                                             -- for this filetypes use typedoc.
typedoc_docs_dir = "docs"                                                        -- the typedoc dir.
typedoc_html_file = "index.html"                                                 -- html file to open with :DookuOpen. This path starts in typedoc_docs_dir, instead of the root directory.
typedoc_clone_config_repo = "https://github.com/Zeioth/vim-typedoc-template.git" -- repo to clone if auto_setup.
typedoc_clone_to_dir = "vim-typedoc-template"                                    -- clone into this dir.
typedoc_clone_cmd_post = ""                                                      -- runs a command after cloning. If you set this option manually, make sure you copy 'typedoc.json' from 'typedoc_clone_to_dir', into the root directory here.
typedoc_cmd = "typedoc"                                                          -- command to run typedoc.

-- jsdoc specific settings
jsdoc_filetypes = { "javascript" }                                               -- for this filetypes use jsdoc.
jsdoc_docs_dir = "docs"                                                          -- the jsdoc dir.
jsdoc_html_file = "index.html"                                                   -- html file to open with :DookuOpen. This path starts in jsdoc_docs_dir, instead of the root directory.
jsdoc_clone_config_repo = "https://github.com/Zeioth/vim-jsdoc-template.git"     -- repo to clone if auto_setup.
jsdoc_clone_to_dir = "vim-jsdoc-template"                                        -- clone into this dir.
jsdoc_clone_cmd_post = ""                                                        -- runs a command after cloning. If you set this option manually, make sure you copy 'jsdoc.json' from 'jsdoc_clone_to_dir', into the root directory here.
jsdoc_cmd = "jsdoc -c jsdoc.json --readme README.md"                             -- command to run jsdoc.

-- rustdoc specific settings
rustdoc_filetypes = { "rust" }                                                   -- for this filetypes use rustdoc.
rustdoc_docs_dir = "target/doc"                                                  -- the rustdoc dir. for rust, this options is only for opening the docs. If you want to change the location where the target directory is created, use the option cargo_rustdoc_args.
rustdoc_html_file = "index.html"                                                 -- html file to open with :DookuOpen. This path starts in rustdoc_docs_dir/crate_name, instead of the root directory. crate_name value will be the name of the project root.
rustdoc_cmd = "cargo rustdoc"                                                    -- command to run rustdoc. Because the options offered by "cargo rustdoc" are a bit limited, you might want to pass -- at the end and pass any of the options you have in "rustdoc --help". But if you do so, be aware some of them may not work with "cargo rustdoc". If this is your care, run the command manually on the terminal first to ensure it works correctly.

-- godoc specific settings
godoc_filetypes = { "go" }                                                       -- for this filetypes use godoc.
godoc_html_url = "localhost:6060"                                                -- url of the godoc server to open with :DookuOpen. When you use :DookuGenerate at least once, the godoc server will keep running until neovin is closed (unless you manually kill the godoc process first).
godoc_cmd = "godoc -index"                                                       -- command to run godoc.

-- ldoc specific settings
ldoc_filetypes = { "lua" }                                                      -- for this filetypes use ldoc.
ldoc_docs_dir = "docs"                                                          -- the ldoc dir.
ldoc_html_file = "index.html"                                                   -- html file to open with :DookuOpen. This path starts in ldoc_docs_dir, instead of the root directory.
ldoc_clone_config_repo = "https://github.com/Zeioth/dooku-ldoc-template.git"    -- repo to clone if auto_setup.
ldoc_clone_to_dir = "dooku-ldoc-template"                                       -- clone into this dir.
ldoc_clone_cmd_post = ""                                                        -- runs a command after cloning. If you set this option manually, make sure you copy 'config.ld' from 'ldoc_clone_to_dir', into the root directory here.
ldoc_cmd = "ldoc ."                                                             -- command to run ldoc.

-- yard specific settings
yard_filetypes = { "ruby" }                                                     -- for this filetypes use yard.
yard_docs_dir = "doc"                                                           -- the yard doc dir.
yard_html_file = "index.html"                                                   -- html file to open with :DookuOpen. This path starts in yard_docs_dir, instead of the root directory.
jsdoc_cmd = "yard"                                                              -- command to run yard.

FAQ

• Explain :DookuAutoSetup to me in detail: All this command do is to clone a repo clone_config_repo into a dir clone_to_dir inside your project root, and then run a command clone_cmd_post to copy the files from the cloned repo to another location, if needed. Normally you don't need to touch any of these options.
• If dooku.nvim does nothing: Ensure you can run the commands defined in jsdoc_cmd, typedoc_cmd, doxygen_cmd, godoc_cmd, rustdoc_cmd or ldoc_cmd on your terminal without errors.
• To pass substrings to an option: You will have to manually scape them with \"\".