Upgrade pydoc-markdown
#2117
Merged
Upgrade pydoc-markdown
#2117
Conversation
This file contains 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
|
@ZanSara I tested the new pydoc-markdown version some month ago. I remember that there were some issues with generating arguments. They were not rendered properly. Let's check how they are rendered on haystack.deepset.ai. |
julian-risch
requested changes
Feb 2, 2022
|
You're right @PiffPaffM, I've made a test deployment from the branch and indeed there are rendering issues: https://haystack-website-c7z7lp2nb-deepset-overnice.vercel.app/reference/primitives I'll try to fix it and keep testing there. |
…ck into upgrade-pydoc-markdown
…ck into upgrade-pydoc-markdown
|
@PiffPaffM I think I managed to get https://haystack-website-6u1fqzxin-deepset-overnice.vercel.app/reference/crawler |
…o the local branch
…t from always show the pipeline as green
…ck into upgrade-pydoc-markdown
PiffPaffM
approved these changes
Feb 3, 2022
…pes-PyYAML and pydoc-markdown
…ck into upgrade-pydoc-markdown
This was referenced Feb 4, 2022
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.
pydoc-markdownwas pinned to a 3.x version, while version 4.x are now stable since a while.I propose to upgrade
pydoc-markdownto make it compatible with Black: in this way, the same bot can apply code and documentation changes in a single commit and reduce the overall commit noise.In addition, the latest
pydoc-markdownseems to introduce some neat improvements, like permalinks to every method (not present before)