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.

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

Jump to bottom

docs: bump docusaurus-plugin-typedoc-api #381

Merged
merged 5 commits into from
Feb 4, 2025
Merged

docs: bump docusaurus-plugin-typedoc-api #381

merged 5 commits into from
Feb 4, 2025

Conversation

barjin
Copy link
Contributor

@barjin barjin commented Jan 23, 2025

Adds the correct inheritance/overrides rendering, multiple function signatures (below), correct optional / keyword-only pills for function arguments.

Reexports https://crawlee.dev/python/api/class/Request .

Peek.2025-01-23.11-32.mp4

@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Jan 23, 2025
@barjin barjin requested a review from vdusek January 23, 2025 10:40
@barjin barjin self-assigned this Jan 23, 2025
@github-actions github-actions bot added this to the 106th sprint - Tooling team milestone Jan 23, 2025
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 23, 2025
@barjin
Copy link
Contributor Author

barjin commented Jan 23, 2025

The Request reexport might be slightly broken (inherited symbols not getting rendered) until we rebuild crawlee-python docs. The docs build there is now manual so we don't have unreleased features in the docs, right?

@B4nan
Copy link
Member

B4nan commented Jan 23, 2025

I think it is triggered by release workflow, but also for beta releases?

@vdusek
Copy link
Contributor

vdusek commented Jan 23, 2025

The docs build there is now manual

Currently it is only manual.

image

vdusek
vdusek reviewed Jan 23, 2025
View reviewed changes
website/docusaurus.config.js Outdated
Comment on lines 120 to 123
{
url: 'https://crawlee.dev/python/api/class/Request',
group: 'Classes',
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I already added this.

https://github.com/apify/apify-sdk-python/blob/master/website/docusaurus.config.js#L120:L124

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! As I expected, it caused some rendering issues with the reexported Request docs (missing inherited symbols). To fix this, we need to deploy Crawlee docs with the latest version of the plugin (and then rebuild SDK docs, preferably with the changes from this PR).

obrazek

@janbuchar
Copy link
Contributor

The docs build there is now manual

Currently it is only manual.

We should align that with crawlee-python and trigger it on pre-releases

@barjin barjin merged commit 75f8d27 into master Feb 4, 2025
27 checks passed
@barjin barjin deleted the docs/bump-plugin branch February 4, 2025 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdusek vdusek vdusek approved these changes

@B4nan B4nan B4nan approved these changes

Assignees

@barjin barjin

Labels
adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Milestone
106th sprint - Tooling team
Development

Successfully merging this pull request may close these issues.
4 participants
@barjin @B4nan @vdusek @janbuchar