search

abey79 / abey79.github.io

Source of my personal website
https://bylr.info
1 stars 0 forks source link

articles/2022/05/10/api-doc-with-sphinx-autoapi/ #12

Open utterances-bot opened 1 year ago

utterances-bot commented 1 year ago

Generating beautiful Python API documentation with Sphinx AutoAPI | bylr.info

Following a recent discussion on Twitter, I decided to take yet another deep dive in my Python projects' documentation and fix once and for all the issues I had with it. I first focused on the automatically-generated API reference section and this article details the results of my finding. Specifically, I’m using vsketch’s API reference, which I recently updated, as an example (documentation source. This article addresses the following objectives:

https://bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi/

fmfreeze commented 1 year ago

Wonderful tutorial with many aspects covered. Thank you so much for sharing :)

Hierosme commented 1 week ago

Thank for that documentation it finally should be a Pull request for autoAPI.

Unfortunally in 2024 the template simply not work for me no error, no message, and bad identation it make it no work at all.