python-wiremock icon indicating copy to clipboard operation
python-wiremock copied to clipboard

Published 20 hours ago • verified publisher icon wiremock

Publish API documentation to ReadTheDocs

Open oleg-nenashev opened this issue 1 year ago • 7 comments

Summary

It would be nice to automate API documentation generation and publishing to the ReadTheDocs site. There are such tools that need to be integrated into the docs publishing Pipeline.

References

  • https://realpython.com/python-project-documentation-with-mkdocs/

oleg-nenashev avatar Aug 09 '23 13:08 oleg-nenashev

I'm interested in this. I'll take a look around and let you know if I'm able to help.

erikkristoferanderson avatar Aug 09 '23 18:08 erikkristoferanderson

@ekand thanks for the interest, it would be awesome!

oleg-nenashev avatar Aug 11 '23 10:08 oleg-nenashev

@oleg-nenashev I've looked around some by now, and it seems like the task is to add the following steps to the docs pipeline:

  • Generate API reference from the source code.
  • Publish all of the docs to ReadTheDocs. Did I understand the task correctly?

erikkristoferanderson avatar Aug 12 '23 00:08 erikkristoferanderson

Exactly!

oleg-nenashev avatar Aug 12 '23 06:08 oleg-nenashev

Okay, great! I'll get to work on that.

erikkristoferanderson avatar Aug 12 '23 21:08 erikkristoferanderson

Thanks a lot 👍

On Sat, 12 Aug 2023, 23:12 Erik Kristofer Anderson, < @.***> wrote:

Okay, great! I'll get to work on that.

— Reply to this email directly, view it on GitHub https://github.com/wiremock/python-wiremock/issues/86#issuecomment-1676101970, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAW4RIGSBHO3PESDQZK7H43XU7WVFANCNFSM6AAAAAA3KAN57M . You are receiving this because you were mentioned.Message ID: @.***>

oleg-nenashev avatar Aug 12 '23 21:08 oleg-nenashev

Can I work on this ? (if its still pending)

kurayami07734 avatar Oct 15 '23 16:10 kurayami07734