[Python] python "auto" documenting the project

Discussão em 'Python' iniciado por Stack, Junho 7, 2025.

  1. Stack

    Stack Membro Participativo

    First I know there is nothing completely to auto documenting, I am aware of that, i am just asking about any tool that could help me to make the documentation fast.

    I have almost finished my scrapy projects and I want to document the code, yes I am bad i didn't do the documentation during the development:

    Anyway, I found sphinx which sounds good but really it needs hard work to document, plus it just provides a web pages for the projects, I was looking for some tools that could do something like this:

    if my code is:

    def myfucnction(var1, var2):
    return 3+3;


    so the code should edit the source code and add the needed rst syntax like """

    then i find sphinx api doc which sounds good, it generates a lot of files, a little bit missy but i can edit them. nevertheless it didn't add anything about the functions and classes in my code, it just created rst files for each python script i have. that is not banefial to me because for my manager, we need for each function the inputs documented and the return documented and a little bit text about the function (really little bit)

    here i am asking for your suggestions, helps. this is my first python project, hope you help me

    Update1


    I was expecting that there could be a tool that generates templates for documentation and I update these templates

    Continue reading...

Compartilhe esta Página