Python Forum
where to find current app documentation standards and tools
Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
where to find current app documentation standards and tools
#1
Is there a generally recommended standard for Python application documentation? I'm discovering reStructured Text and Sphinx but I'd like to know if that's commonplace and if not, is there a widely recommend doc ecosystem?
Reply
#2
There is a general guideline at python.org here.
I crank out code quickly, most documentation, except for very complicated methods, I keep in a separate document.
I do, often, add one liners at the beginning of a method, but only when coding at a relaxed pace, which is rarely the case.
Reply
#3
Let me point out that the guideline linked by @Larz60+ is intended for the documentation of the Python language itself. It is not meant for people writing external Python libraries. Other guides exist, such as this one

The best libraries in the Python Package Index use Sphinx for their documentation and they often publish it on the readthedoc site.
Larz60+ and radlyeel like this post
« We can solve any problem by introducing an extra level of indirection »
Reply


Possibly Related Threads…
Thread Author Replies Views Last Post
  How to find out from outside Python (in Windows) the current version of Python? pstein 5 2,202 Jun-28-2024, 07:02 AM
Last Post: Samuel34
  I'm not able to find any documentation about pyswip for python alien75 1 2,638 Apr-21-2020, 02:09 PM
Last Post: Larz60+
  video processing tools sveto4ka 2 2,472 Oct-23-2019, 01:27 PM
Last Post: sveto4ka
  Help with pyGenealogical-Tools (Updated) Matan_ran 5 163,449 Oct-16-2019, 08:48 PM
Last Post: Larz60+

Forum Jump:

User Panel Messages

Announcements
Announcement #1 8/1/2020
Announcement #2 8/2/2020
Announcement #3 8/6/2020