Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

TypeDoc and modules

I'm trying to generate documentation for my TypeScript project with TypeDoc. The generation works, except for that I can't find out how to organise my classes into modules and have TypeDoc display them as such.

Currently my classes are just organized by directories, but TypeDoc doesn't seem to recognize that (everything is Global). I think there should be another way to define the modules, but I cannot find how.

Does anyone have experience with this? Thanks!

This is what I currently have:

enter image description here

This is what I'm trying to get:

enter image description here

like image 468
Bert Willekens Avatar asked Oct 18 '22 09:10

Bert Willekens


1 Answers

There is a plugin which does the trick for me. typedoc-external-module-name You can organize the files in kind of "logical" modules.

like image 105
Michael Hoeller Avatar answered Nov 15 '22 07:11

Michael Hoeller