• articles
  • about
  • contact
tech dumplings
by Zajdel

documentation

  • Software Development

Autogenerated Python code documentation with MkDocs

Posted on June 4, 2024by Aleksandra

Just like you need a map when exploring a new area, other users need guidance on your project. Undoubtedly,  self-describing source code is a good practice but the code itself doesn’t explain everything. Questions may arise such as: why the module is being written? Why is it implemented in such a way? What’s the database […]

Read More
No comments yet

Welcome to tech dumplings,
a blog that is filled with technology-related topics topped with self-development insights.
Get ready to savor a delightful combination of knowledge and inspiration in every bite.

Aleksandra and Filip
Zajdel

Categories

  • Software Development 7
  • Personal Development 1

Recent Posts

Autogenerated Python code documentation with MkDocs - 04 Jun , 2024
Optimize debugging time from O(n) to O(logn) with git bisect - 13 Mar , 2024
The Code Review Essentials – the reviewer’s side - 17 Oct , 2023
10 useful Git commands for collaborative development - 15 Oct , 2023
2 easy tips to manage environment variables in Python - 14 Oct , 2023
Quality Assurance for Python project - 12 Oct , 2023
Super simple productivity recipe - 11 Oct , 2023
Self-hosted password manager - 04 Oct , 2023

Copyright © tech dumplings
All rights reserved