docs: update @apify/docusaurus-plugin-typedoc-api
#713
Conversation
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
barjin
added
documentation
barjin
commented
Nov 20, 2024
|
|
||
| run-docs: build-api-reference | ||
| cd website && corepack enable && yarn && yarn start | ||
| cd website && corepack enable && yarn && poetry run yarn start |
There was a problem hiding this comment.
Since the plugin now runs pydoc-markdown (and other python tooling) automatically, we need to run the Docusaurus build with the correct venv using poetry run (hopefully this is how it works).
barjin
commented
Nov 20, 2024
| pythonOptions: { | ||
| pythonModulePath: path.join(__dirname, '../src/crawlee'), | ||
| moduleShortcutsPath: path.join(__dirname, 'module_shortcuts.json'), | ||
| }, |
There was a problem hiding this comment.
The new unified API docs generating pipeline - we don't need to generate the json ourselves, just supply the path to the project (and the module_shortcuts.json file, which we might want to remove / integrate later, further simplifying the interface).
B4nan
approved these changes
Nov 20, 2024
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.
Updating the plugin allows us to use the new unified transformation pipeline instead of handling the API docs generation separately in each Python project.
The new version also now renders the Typedoc objects in machine-readable elements on the page, so we can use the new
reexportsplugin option (more about that in a PR inapify-sdk-python).