Auto Generated Documentation using MkDocs + MkDocStrings | Python

Поділитися
Вставка
  • Опубліковано 12 гру 2024

КОМЕНТАРІ • 12

  • @udirt
    @udirt 7 місяців тому

    thank you - most people don't even *cover* automatic generation from code comments, they might have fancy videos, but much less useful. glad I found yours. I'm not a dev and just know "this should be possible in a better way" but need tutorials from someone who actually understands what they do.

  • @ramirojativa6812
    @ramirojativa6812 Рік тому

    A perfect explanation of how to generate the self-documentation of a project in python using MkDocs The best I've seen in videos so far. I was stuck with Sphinx and hadn't heard of MkDocs until now. MkDocs has the ability to generate the self-documentation of the code (particularly Python) in my case in an automatic way and without the complications of Sphinx. Congratulations and thank you!

  • @shawn.builds
    @shawn.builds 8 місяців тому

    was having some issues with the docs and this pushed me through. thanks!

  • @mpetty7052
    @mpetty7052 Рік тому +1

    Great video! Exactly what I needed to try out using MkDocs and mkdocstrings, works great.

  • @Tubaii25
    @Tubaii25 9 місяців тому

    This was a very helpful introduction. It helped me get started with MkDocs and mkdocstrings with ease. Thank you!

  • @plashless3406
    @plashless3406 Рік тому +1

    amazing. Tried a lot but found you. Thanks man.

  • @LucasDesperrois
    @LucasDesperrois 10 місяців тому

    There is one error where you install mkdocstring[python]. The command isn't : pip install "mkdocsstrings[python]" but pip install "mkdocstrings[python]"

  • @KirankumarTamvada
    @KirankumarTamvada Рік тому

    I have production-ready code with well-documented class-based functions. Is it safe to use this code, or is there any possibility that this library might inadvertently share our data internally? I need to be cautious and avoid any risks.