docs: Improve API doc groups #1309
Conversation
Closes: #1293
| @@ -12,7 +12,7 @@ | |||
| RequestHandler = Callable[[TCrawlingContext], Awaitable[None]] | |||
|
|
|||
|
|
|||
| @docs_group('Classes') | |||
| @docs_group('Others') | |||
| class Router(Generic[TCrawlingContext]): | |||
There was a problem hiding this comment.
I'm not sure about the Others group for Router.
But I'm not sure which group would be better
src/crawlee/_utils/docs.py
Outdated
| 'Functions', | ||
| 'HTTP clients', | ||
| 'HTTP parsers', | ||
| 'Others', |
There was a problem hiding this comment.
Could we use a singular (Other) here and also move it to the bottom of the class list?
There was a problem hiding this comment.
Updated to "Other". However, the sequence defined in GroupName doesn't affect the order in the rendered page.
There was a problem hiding this comment.
I know, but I don't know where to change this to actually change the order 😁 Could you please give it a try?
There was a problem hiding this comment.
Group sorting is implemented in the docusaurus-plugin-typedoc-api. @barjin will do the changes, and once that's done, we can bump the package version here.
|
Nice, this is way more readable. I was looking at Resource Management? Request customization? |
|
Sorry, I added an outdated image to the PR description. This is the current state (so I'm not sure Pepa about your suggestions): 
|
Hmm, maybe let's do it in the future when we have more "middlewares".
Yeah, I'd also like to put it somewhere, but I have no idea where :D. |
Description
Render of the whole page:
I am open to any suggestions for better grouping it. Maybe we can even hide something from "Others"?
Issues
Testing
Checklist