Hey! TLDR You guys are doing a good job so I wanted your advice :)
As part of my job I write programming language (something small for inner use), and I wanted to ask what tool you guys use to document your api, for example: https://docs.python.org/3/library/argparse.html
I really like that it is version based, there is a search engine, and the general format.
Thanks!, Elad
Hi Elad,
Python documentation is built using Sphinx and restructuredText markup.
You can read about sphinx here: https://www.sphinx-doc.org/en/master/ You can also read more on our documentation workflow on the devguide: https://devguide.python.org/documenting/
I gave a talk that introduces all these tools which might help you get started with building your own documentation: https://www.youtube.com/watch?v=stsIWxrh1Xs
P.S We're not all guys here, I would appreciate it if you could use more inclusive terminologies in the future, like "you", "you all", or "everyone". See https://heyguys.cc/
Thanks.
participants (2)
-
elad allot -
Mariatta