Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where does typedoc get the module names from? #242

Closed
0815fox opened this issue Jun 20, 2016 · 3 comments
Closed

Where does typedoc get the module names from? #242

0815fox opened this issue Jun 20, 2016 · 3 comments

Comments

@0815fox
Copy link

0815fox commented Jun 20, 2016

Maybe it's a stupit question...?

Looking at the typedoc documentation, I see it uses the modules mode. Where does it get the modules td, td.converter, td.models, td.output from?

I can nowhere find "td" in the sources as module name?

How does e.g. output become a module, while utils does not?

@0815fox 0815fox changed the title Where does typedoc get the module names for? Where does typedoc get the module names from? Jun 21, 2016
@MaPUILabs
Copy link

Yeah same for me. I dont really understand this.
When I build the exemples doc (the one in exemples/self) I don't even have "the td.something" modules, it looks like every file is displayed as a module.

I have the same problem on my personnal project. Is there any solution ?
capture

@aciccarello
Copy link
Collaborator

@MaPUILabs
You are probably using "files" mode which considers each file a separate module.

--mode <file|modules>
Specifies the output mode the project is used to be compiled with.

@0815fox, I think that the typedoc.io site hasn't been updated in a while. You'll notice that there is no td/ directory as specified in the documentation links. That was changed when typedoc updated to 0.4.0

@lucaterribile
Copy link

I have similiar issue, each file is displayed as module, and documentations and modules are not group by namespace hierarchy.

Is there any solution?

Example: If I have 2 modules with namespace AA.BB.CC e AA.BB.DD, I would like navigate in documentation using namespace hierarchy:

AA
---BB
-----CC
-----DD

Thanks,
Luca

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants