apidoc icon indicating copy to clipboard operation
apidoc copied to clipboard

Support templating

Open gsemet opened this issue 6 years ago • 5 comments

Hello

Is it possible to add an option to change the default menu item names:

  • the first level has the name of the module while I'd like to have something like "API Reference". Could be an option such as apidoc_title = "API Reference"
  • is it possible to display the content of a module before its sub-modules?
  • using a lot git submodules, seeing "Submodules" in the menu is weird. Is it possible to simply skip this level and gather all sub-module inside the package?

So instead of:

mypackage_name
    mypackage_name package
        Submodules
            mypackage_name.one_module module
            mypackage_name.another_module module
            mypackage_name.yet_another_one module
        Module contents

We would have something like:

API Reference
    mypackage_name package
        Module contents
        mypackage_name.one_module module
        mypackage_name.another_module module
        mypackage_name.yet_another_one module

gsemet avatar May 30 '18 08:05 gsemet