logo
Practitioners Guide to Great Project Documentation feat. ReadTheDocs
Initializing search
  • Home
  • About
  • Tags
  • Bookmarks
  • Interests
  • Photography
  • Archive
  • Categories
  • Home
  • About
  • Tags
      • How to Win Friends and Influence People
      • Mossad
      • Raw : A History Of India's Covert Operations
      • The Bhagavad Gita For Millenials
        • Rebuilding Netflix Video Processing Pipeline with Microservices
        • COVID Test Data Breach: 1.3 Million Patient Records Exposed Online
        • I Just Wanted Emacs to Look Nice — Using 24 Bit Color in Terminals Chad Austin
        • I Just Wanted Emacs to Look Nice — Using 24-Bit Color in Terminals | Chad Austin
        • Preface - LSM in a Week
        • How we got fine-tuning Mistral-7B to not suck: Helix Project Report, Feb 2024
        • Simple Precision Time Protocol at Meta - Engineering at Meta
        • Excalidraw
        • @ASmartBear
        • Apache Superset | Hacker News
        • https://zeck.app
        • Start a Profitable Side Project in 2024 - Indie Hackers
        • a16z Consumer Abundance Agenda
        • Rogo
        • Voxel
        • Chief AI Decks
        • Personal Branding—Most Important Thing You Do. Full Video AdobeMAX 2023
        • Please Stop Using Google Analytics
        • ULTRA.VC
        • ron0studios/C-Plus-Plus: Collection of various algorithms in mathematics, machine learning, computer science and physics implemented in C++ for educational purposes.
        • Wait... PostgreSQL can do WHAT?
        • Building Meta’s GenAI Infrastructure - Engineering at Meta
        • Logarithm: A logging engine for AI training workflows and services - Engineering at Meta
        • Next.js Commerce – Vercel
        • sanity-io/hydrogen-sanity-demo: A starter for Hydrogen + Sanity projects
        • failsafe-go/failsafe-go: Fault tolerance and resilience patterns for Go
      • The Morning Brief [2023 06 06]
      • 16. Bhagavad Gita | Chapter 2 Verse 45 - 47 | Swami Sarvapriyananda
      • Aakrit-Haptik-Varun-Mayya
          • Weekly Digest Week 05
          • Weekly Digest Week 06
          • Weekly Digest Week 09
          • Weekly Digest Week 10
          • Weekly Digest Week 11
          • Weekly Digest Week 12
          • Weekly Digest Week 13
          • Weekly Digest Week 14
          • Weekly Digest Week 15
          • Weekly Digest Week 16
          • Weekly Digest Week 17
          • Weekly Digest Week 18
          • Weekly Digest Week 20
          • Weekly Digest Week 21
          • Weekly Digest Week 22
          • Weekly Digest Week 22
      • FIRE
      • InvenstmentPhilosophy
      • Investment System
      • Trading & Finanace
        • ERIS-ErisLifesciencesLtd
        • SBCL_ShivalikBimetal
      • Geo-politics
      • Indo-China War prospects
      • Linux Internals MOOC
        • 06.01 Life of a Packet
        • 06.02 Kernel High Performance Networking
        • 06.03 Bypassing the Kernel
        • 06.04 What Should I use
        • 09.xx Performance Monitoring
        • 10.01 eBPF History, Motivation and Design
        • 10.02 Hello eBPF
        • 10.03 eBPF Maps
        • 10.04 XDP
        • 10.05 eBPF & Tracing
      • Photography
      • Video and Photography
        • Geeta Readings
  • Photography
    • 2024
    • Business
    • Engineering
    • Insights
    • Management
Back to index
  • Metadata
    • March 12, 2024
    • in Engineering
    • 1 min read
topic/engineering-management topic/pkm

Practitioners Guide to Great Project Documentation feat. ReadTheDocs

markdown - Python docstrings to GitHub README.md - Stack Overflow python - Read The Docs not working with automodule - Stack Overflow

reStructuredText vs Markdown for documentation

docs

Previous Startup CTO : Impatient , Lazy and how I learned the habit of plan-sprint-ship-document
Next Productivity Audits & the Fine art of Mastering Your Day
Copyright © 2012 - 2024 Shaishav Kr | @wiresurfer