docs: reexport storages documentation from crawlee-python#328
Merged
Conversation
vdusek
reviewed
Nov 20, 2024
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
reviewed
Nov 20, 2024
janbuchar
left a comment
Contributor
There was a problem hiding this comment.
Seems cool at a glance, thanks! Let me know if there's something you want me to read thoroughly.
Contributor
It passes now, let's merge it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the
@apify/docusaurus-plugin-typedoc-apiplugin, 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_groupand@docs_namedecorators (just like in crawlee-python). Those decorators could be moved up into some shared package (e.g.apify-shared, which already has the@ignore_docsdecorator).Uses the new
reexportsfeature of the plugin to load external API docs (fromcrawlee.dev/python) and re-render them in the current documentation instance.