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

projectDocuments in a merge entryPointStrategy site #2801

Closed
alexprudhomme opened this issue Dec 5, 2024 · 7 comments
Closed

projectDocuments in a merge entryPointStrategy site #2801

alexprudhomme opened this issue Dec 5, 2024 · 7 comments
Labels
question Question about functionality

Comments

@alexprudhomme
Copy link

alexprudhomme commented Dec 5, 2024

Search terms

entryPointStrategy, merge, projectDocuments, documents

Question

Hi,

I am having trouble setting up projectDocuments for my typedoc site.

I am building a Typedoc site with "entryPointStrategy": "merge", that takes in two --json builded sites. Project documents work fine in the root Typedoc project. However if I try to add some in the two --json builded site, they don't show up.

They seem to show up as "documents" in the json file so I am not sure what I am doing wrong. Before digging up further, is this something that is supported ?

@alexprudhomme alexprudhomme added the question Question about functionality label Dec 5, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 6, 2024

Yes, this is supported! I just pushed a gh2801 branch to typedoc-packages-example which demonstrates it (build with the advanced settings in the readme to replicate your JSON setup)

image

Note that the documents for sub-projects will show up within the module created for that project, not at the top level.

@alexprudhomme
Copy link
Author

alexprudhomme commented Dec 9, 2024

I see, thanks for the example. My problem was that I had his at the root typedoc (the one merging). and it was removing the projectDocuments. Dont know if this would count as a bug.

  "navigation": {
    "includeGroups": true
  },

repro here https://github.com/alexprudhomme/typedoc-merge-documents

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 10, 2024

That repo has an old version of typedoc installed - before 0.27 categorization/grouping wasn't performed on merged projects, so yes, it won't work there.

@alexprudhomme
Copy link
Author

alexprudhomme commented Dec 10, 2024

Hi, I updated to the latest version and it still does not work. I have tried many setups and could not find one where I had categories/group + sub package documents. I updated the repo if you want to take a look. https://github.com/alexprudhomme/typedoc-merge-documents

image image

Gerrit0 added a commit that referenced this issue Dec 12, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 12, 2024

That's a bug! The group/category restoration code missed checking for documents, easy fix at least.

@alexprudhomme
Copy link
Author

Thanks a lot ! I suppose this will be in 0.27.5 ?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 12, 2024

Yes, likely this weekend, there are a couple other issues I want to look at

@Gerrit0 Gerrit0 closed this as completed Dec 14, 2024
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

2 participants