https://mrbmp33.github.io/tags/sphinx/Recent content in Sphinx on Bernat's PortfolioHugo -- gohugo.ioenMon, 11 May 2026 00:00:00 +0000https://mrbmp33.github.io/posts/document_your_code/Mon, 11 May 2026 00:00:00 +0000https://mrbmp33.github.io/posts/document_your_code/<h2 id="why-this-guide">Why this guide?</h2> <p>Documentation is one of those things every developer <em>knows</em> they should do… until the project grows, deadlines hit, and the README becomes a fossil from three months ago.</p> <p>If you are reading this, you probably already understand the importance of documenting your code — not just for others, but also for your future self trying to remember why you wrote something at 2AM six months ago.</p> <p>I’ve done this in the past for personal projects, and getting everything working can be somewhat complicated at first. This guide is a practical walkthrough for anyone wanting to set up clean, maintainable documentation for Python code using Sphinx.</p>