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

Add a custom pydoc renderer for Readme.io #2825

Merged
merged 6 commits into from Jul 22, 2022
Merged

Add a custom pydoc renderer for Readme.io #2825

merged 6 commits into from Jul 22, 2022

Conversation

masci
Copy link
Member

@masci masci commented Jul 15, 2022 •
edited

Related Issue(s): n/a

This PR adds a custom renderer for markdown files generated with pydoc. The renderer would add a frontmatter that's used in Readme.io.

The changes that would be needed for each module we convert to markdown would be like this:
https://github.com/deepset-ai/haystack/pull/2825/files#diff-29a1c308e27891d5d31bb706765852e1158ba470261d56448c2ec97aa00d730e

Proposed changes:

  • Add a custom renderer
  • Make the frontmatter configurable through regular pydoc config files

Pre-flight checklist

@masci masci added the type:documentation Improvements on the docs label Jul 15, 2022
@masci masci requested a review from brandenchan July 15, 2022 11:55
brandenchan
brandenchan approved these changes Jul 19, 2022
View reviewed changes
Copy link
Contributor

@brandenchan brandenchan left a comment

Choose a reason for hiding this comment

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

LGTM

@masci masci marked this pull request as ready for review July 22, 2022 07:50
@masci masci merged commit 8ee2b6b into master Jul 22, 2022
@masci masci deleted the massi/pydoc-readme-renderer branch July 22, 2022 08:43
Krak91 pushed a commit to Krak91/haystack that referenced this pull request Jul 26, 2022
@masci
Add a custom pydoc renderer for Readme.io (deepset-ai#2825)
3e88199 
* add custom pydoc renderer

* create an example

* revert example code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brandenchan brandenchan brandenchan approved these changes

Assignees
No one assigned
Labels
type:documentation Improvements on the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@masci @brandenchan