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

Can we suppress the subfolders that pages are generated into? #2394

Closed
fhaag opened this issue Sep 12, 2023 · 4 comments
Closed

Can we suppress the subfolders that pages are generated into? #2394

fhaag opened this issue Sep 12, 2023 · 4 comments
Labels
question Question about functionality

Comments

@fhaag
Copy link

fhaag commented Sep 12, 2023

Search terms

subfolders

Question

When Typedoc generates its article pages for each type, it sorts these files into subfolders according to what each of them describes - enums, classes, interfaces, and so on.

Can we suppress this, or tell Typedoc to use the same subfolder for all pages?

Background: Based on the module name and type name (which should be sufficiently unique; after all, we use nothing else when importing from another module in TypeScript), I am trying to automatically determine the URL to our Typedoc documentation. The fact that for this to work, I need to know whether a given identifier is e.g. a class, an interface, or anything else, is the only blocker left for me.

@fhaag fhaag added the question Question about functionality label Sep 12, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 13, 2023

Not yet supported - tracked in #2111

@fhaag
Copy link
Author

fhaag commented Sep 13, 2023

@Gerrit0: I appreciate the link and I happily accept if it somehow covers my requirements.

However, I did find and read that other ticket before posting my question, and I just read it again, and both times, I saw little definitive overlap between my question and the other ticket. #2111 appears to be about a linking problem, restricted to functions, somehow specific to Cloudflare (?).

The ticket title ("Support for custom output directory structure") and a single sentence in the ticket ("I guess, what I'd like to see is a way to have customization over the file/folder structure.") sound reminiscent of what I'm asking about, but even the detailed description of the latter ("Maybe functions can be nested under their modules?") goes into a totally different direction.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 16, 2023

Fair enough - my eventual goal there is to support fully customizing the output folder structure to allow both flattened and nested structures, or somewhere in between like TypeDoc today, I haven't figured out what that looks like yet

@mogelbrod
Copy link
Contributor

I would love this too!

@Gerrit0 Gerrit0 closed this as completed Nov 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

3 participants