Skip to content

docs: update symbol group ordering #1313

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 22, 2025
Merged

docs: update symbol group ordering #1313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/crawlee/_utils/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from collections.abc import Callable
from typing import Any, Literal, TypeVar

# The order of the rendered API groups is defined in the docusaurus-plugin-typedoc-api.
# The order of the rendered API groups is defined in the website/docusaurus.config.js file.
GroupName = Literal[
'Autoscaling',
'Browser management',
Expand Down
24 changes: 16 additions & 8 deletions website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,24 @@ const path = require('path');
const { externalLinkProcessor } = require('./tools/utils/externalLink');

const GROUP_ORDER = [
'Classes',
'Abstract classes',
'Data structures',
'Autoscaling',
'Browser management',
'Configuration',
'Crawlers',
'Crawling contexts',
'Errors',
'Event data',
'Event managers',
'Functions',
'Constructors',
'Methods',
'Properties',
'Constants',
'Enumeration Members',
'HTTP clients',
'HTTP parsers',
'Request loaders',
'Session management',
'Statistics',
'Storage clients',
'Storage data',
'Storages',
'Other',
];

const groupSort = (g1, g2) => {
Expand Down