Publish API documentation to ReadTheDocs

[oleg-nenashev]

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/

[erikkristoferanderson]

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

[oleg-nenashev]

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

[erikkristoferanderson]

@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?

[oleg-nenashev]

Exactly!

[erikkristoferanderson]

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

[oleg-nenashev]

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 <#86 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAW4RIGSBHO3PESDQZK7H43XU7WVFANCNFSM6AAAAAA3KAN57M> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[kurayami07734]

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