openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[REQ] Better Julia document organization:

Open NeroBlackstone opened this issue 1 year ago • 0 comments

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

NeroBlackstone avatar May 07 '24 11:05 NeroBlackstone