Skip to content

Show short submodule names in TOC #265

Open
@jackblk

Description

@jackblk

Sorry for asking a very basic question but I've done some research & no result.

Here's my folder structure:
main-long-name-folder
|--modules
|----|--helper.py
|--test.py

I'm using some functions in helper.py like helper.action1(). I use pdoc to generate HTML. Problem is, after generating successfully, the sub-modules in left sidebar has long package prefix name, for example: main-long-name-folder.modules.

I figure that I can change the name by changing the folder name main-long-name-folder to main then run the pdoc again, but it is not a good way to do because the repo name is fixed, I don't want to change folder name.

Do we have anyway to re-define the package name or changing refname of package to make it a lot shorter?

Thanks a lot.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions