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.

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

Add support for rST field lists, refs #275 #369

Merged
merged 4 commits into from
Mar 30, 2022

Conversation

mhils
Copy link
Member

@mhils mhils commented Mar 30, 2022

This PR adds support for field lists for reStructuredText docstrings. 😃

(CC @talnagar)

@mhils mhils enabled auto-merge (squash) March 30, 2022 16:41
@mhils mhils merged commit 7dc9e17 into mitmproxy:main Mar 30, 2022
@mhils mhils deleted the rst-field-lists branch March 30, 2022 18:59
@talnagar
Copy link

talnagar commented Apr 3, 2022

thanks @mhils that's awesome!

@talnagar
Copy link

talnagar commented Apr 3, 2022

Is there a planned release soon with this PR?

@mhils
Copy link
Member Author

mhils commented Apr 3, 2022

You normally should be able to just install from GitHub:

pip install git+https://github.com/mitmproxy/pdoc.git
# or pin a specific commit:
pip install git+https://github.com/mitmproxy/pdoc.git@d2169a3690f07aee138c6ff34f53e5b80fb1a55b

I plan to ship a proper release in the next week or two, there are still a few things on my immediate idea list I'd like to include. :)

@talnagar
Copy link

talnagar commented Apr 4, 2022

thanks @mhils I'll wait for the official release. we decided to incorporate pdoc into all of our ci/cd pipelines so we prefer a standard installation. 😄

@mhils
Copy link
Member Author

mhils commented Apr 6, 2022

FYI, pdoc 11 is out. :)

@talnagar
Copy link

talnagar commented Apr 6, 2022

thanks @mhils! such an awesome project, I hope to contribute too in the future,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants