Skip to content

docs: reexport storages documentation from crawlee-python#328

Merged
janbuchar merged 6 commits into
masterfrom
chore/bump-typedoc
Nov 20, 2024
Merged

docs: reexport storages documentation from crawlee-python#328
janbuchar merged 6 commits into
masterfrom
chore/bump-typedoc

Conversation

@barjin

@barjin barjin commented Nov 20, 2024

Copy link
Copy Markdown
Member

Updates the @apify/docusaurus-plugin-typedoc-api plugin, which enables us to use the unified Python documentation pipeline (instead of handling it in each Python project separately).

Decorates the symbols to be documented with @docs_group and @docs_name decorators (just like in crawlee-python). Those decorators could be moved up into some shared package (e.g. apify-shared, which already has the @ignore_docs decorator).

Uses the new reexports feature of the plugin to load external API docs (from crawlee.dev/python) and re-render them in the current documentation instance.

@barjin barjin added documentation Improvements or additions to documentation. adhoc Ad-hoc unplanned task added during the sprint. labels Nov 20, 2024
@barjin
barjin requested review from janbuchar and vdusek November 20, 2024 09:56
@barjin barjin self-assigned this Nov 20, 2024
@github-actions github-actions Bot added this to the 103rd sprint - Tooling team milestone Nov 20, 2024
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Nov 20, 2024
Comment thread src/apify/_actor.py

@vdusek vdusek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm otherwise

@barjin

barjin commented Nov 20, 2024

Copy link
Copy Markdown
Member Author

Is it alright to merge with the failing 3.13 Integration test? Is it the flaky one you guys were talking about, or is there something I should do about it?

@janbuchar janbuchar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems cool at a glance, thanks! Let me know if there's something you want me to read thoroughly.

@vdusek

vdusek commented Nov 20, 2024

Copy link
Copy Markdown
Contributor

Is it alright to merge with the failing 3.13 Integration test? Is it the flaky one you guys were talking about, or is there something I should do about it?

It passes now, let's merge it.

@janbuchar
janbuchar merged commit 777637a into master Nov 20, 2024
@janbuchar
janbuchar deleted the chore/bump-typedoc branch November 20, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. documentation Improvements or additions to documentation. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants