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

Separate by folder #3697

Open
fulldecent opened this issue Apr 12, 2024 · 2 comments
Open

Separate by folder #3697

fulldecent opened this issue Apr 12, 2024 · 2 comments

Comments

@fulldecent
Copy link
Contributor

I am using phpDocumentor on a large project, Moodle. It generates over 10GB of website output.

https://github.com/fulldecent/phpdoc/actions/runs/8655960879/job/23735714726

One specific issue with Moodle is that a lot of code is top-level functions that are not namespaced. So the current index page of docs (now at https://fulldecent.github.io/phpdoc/) is too big to load. And search freezes the browser.

Other pages work great.

So maybe there is some way to suppress part of the index page or maybe there is some way to break down sections of the documentation automatically based on the folder structure.

Just putting ideas here. Maybe someone has a practical workaround.

@phpdoc-bot phpdoc-bot added this to Needs triage in phpDoc issue triage board Apr 12, 2024
@jaapio
Copy link
Member

jaapio commented May 7, 2024

Thanks for your interest in phpDocumentor and your kind words.

The easiest solution for this would be to overwrite the index template. We do already render all file separately, like you can see here: https://fulldecent.github.io/phpdoc/indices/files.html

You could try to use the template extension. This allows you to create even more custom pages. So you can make a selection of functions for example on alphabetic order. Right now we do not have a system documented that would allow you to do this more automated.

The template extension feature will be part of the new 3.4 release that will be coming soon. ™️

Regarding the search functionality, I do not have a very good solution right now.

I hope this helps you a bit.

@jaapio jaapio added the question label May 7, 2024
@fulldecent
Copy link
Contributor Author

Also some discussion of template modification at #2865


Thank you! I can close this here and I will look out for the 3.4 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
phpDoc issue triage board
  
Needs triage
Development

No branches or pull requests

2 participants