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

[REQ] Better Julia document organization: #18595

Open
NeroBlackstone opened this issue May 7, 2024 · 0 comments
Open

[REQ] Better Julia document organization: #18595

NeroBlackstone opened this issue May 7, 2024 · 0 comments

Comments

@NeroBlackstone
Copy link

NeroBlackstone commented May 7, 2024

Is your feature request related to a problem? Please describe.

I noticed that the documentation generated by julia-client openapi-generator generates a separate .md file for each Response Object, but this is not easy to organize and may generate hundreds of separate .md files in the docs directory.

More importantly, existing document generation does not integrate well with docuenter.jl. You need to manually create make.jl and add entries to the file.

Describe the solution you'd like

  1. Merge Response Results Object documents for individual API end-points, for example, tv-series-watch-providers, we can merge these Response Results Object document to one page. This way the document doesn’t look unorganized.

image

  1. Add built-in documenter.jl support, once documents are generated, it should provide everything for build web pages

Additional context

If you think these ideas are good, I can take a look at the code and open a PR (if I can understand it)

cc: @tanmaykm

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

No branches or pull requests

1 participant