Python Documentation

Open-source Python projects categorized as Documentation

Top 23 Python Documentation Projects

  • professional-programming

    A collection of learning resources for curious software engineers

  • Project mention: A collection of learning resources for curious software engineers | news.ycombinator.com | 2024-02-19

    The inclusion of the perspective section: https://github.com/charlax/professional-programming?tab=read... I think is really smart. Same for personal productivity. Two things that can dramatically change how and what you end up studying and doing with your time / life.

    I did a coding bootcamp and yeah the frontend knowledge they taught was useful, but I could have learned that online for free. Looking back, the far more valuable thing I learned was how to discipline myself and my time - that was the first time in my life I was truly disciplined and mindful in how I spent my time. I also got perspective I'd never seen before: there was some folks in my cohort that were in their 30s and 40s and undergoing career change, and I learned two things from them: First, don't stress too much, your life has much more flexibility than you might expect (this truth is borne out, they all have perfectly successful careers in their new lives as engineers), and second, make a great use of the time you have.

    Bog-standard advice we all know, but to witness it firsthand from people living it and sharing it is different. The shared article in the github is incredible: https://www.theguardian.com/commentisfree/2020/sep/07/termin...

    I often wonder why I don't see more of these sorts of articles. From watching a family member slowly die of cancer, and from reading books like "When Breath Becomes Air," I'm guessing it's some combination of exhaustion, disability, and a new set of priorities that doesn't really involve death blogging. Still, I find these kinds of writings more poignant than most things I read.

  • cheat.sh

    the only cheat sheet you need

  • Project mention: Ask HN: What are your go to shell one-liners? | news.ycombinator.com | 2024-04-22

    curl https://cheat.sh/$1

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
  • wtfpython

    What the f*ck Python? 😱

  • Project mention: What the Fuck Python? | news.ycombinator.com | 2023-08-27
  • MkDocs

    Project documentation with Markdown.

  • Project mention: I am stepping down from MkDocs | news.ycombinator.com | 2024-04-07
  • sphinx

    The Sphinx documentation generator

  • Project mention: 5 Best Static Site Generators in Python | dev.to | 2023-11-24

    Sphinx is primarily known as a documentation generator, but it can also be used to create static websites. It excels in generating technical documentation, and its support for multiple output formats, including HTML and PDF, makes it a versatile tool. Sphinx uses reStructuredText for content creation and is highly extensible through plugins.

  • documentation

    The official documentation for Raspberry Pi computers and microcontrollers (by raspberrypi)

  • Project mention: Selfhostate e avete un homelab? | /r/ItalyInformatica | 2023-12-10
  • pdoc

    API Documentation for Python Projects

  • Project mention: How to Write Impeccably Clean Code That Will Save Your Sanity | dev.to | 2023-07-27

    You can also use doc-strings to generate automated documentation for your code using a library like pdoc. Consider the following example from Stack-Scraper and the corresponding documentation generated using pdoc library.

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • readme-ai

    👾 Automated README file generator, powered by large language model APIs.

  • Project mention: README-AI: Auto-generate README.md files! | /r/Python | 2023-05-18

    Hey fellow Redditors, Just wanted to share a cool way I've been using ChatGPT recently. I've been messing around with README-AI, a fantastic tool that auto-generates really slick README files for GitHub repos, and I had an idea for a new feature (GitLab support, for anyone interested). But rather than write the feature request issue myself, I let ChatGPT handle it! That's right, I got an AI to write a GitHub issue for a tool that uses AI. Sounds like an inception, right? Check out the issue here: https://github.com/eli64s/README-AI/issues/13 I think it's pretty impressive how coherently and effectively ChatGPT can communicate an idea. Just another interesting application for AI. Anyone else using ChatGPT in novel ways? Would love to hear your stories! Oh, and just for the record, this Reddit comment itself was also generated by ChatGPT. It seems like the AI rabbit hole goes even deeper. 😉 Cheers!

  • apispec

    A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..

  • pdoc

    :snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects (by pdoc3)

  • pyment

    Format and convert Python docstrings and generates patches

  • portray

    Your Project with Great Documentation.

  • Pycco

    Literate-style documentation generator.

  • Project mention: Pycco – quick-and-dirty, hundred-line-long, literate-programming docu generator | news.ycombinator.com | 2024-01-27
  • videos

    This is my video documentation. Here you'll find code-snippets, technical documentation, templates, command reference, and whatever is needed for all my YouTube Videos. (by ChristianLempa)

  • Project mention: Having trouble in getting SSL in Nginx Proxy Manager and Cloudflare, Docker. | /r/selfhosted | 2023-11-05

    Hey all, I am trying to build my home server to have nextcloud to store most of my stuff. I started the journey without any significant knowledge about hosting. So far: * I got a domain name. I moved the nameservers to Cloudflare. * Got to know that ipv4 was being blocked by ISP for port forwarding but ipv6 wasn't. So opened the ports on ipv6 address. Checked the open ports of public ipv6 address and they were showing open. * I installed the Nginx Proxy Manager along with Nextcloud on Docker by following the following tutorial: https://www.youtube.com/watch?v=iFHbzWhKfuU&list=LL&index=2&t=457s The docker file is in here: https://github.com/christianlempa/videos/tree/main/nextcloud-tutorial

  • vsphere-automation-sdk-python

    Python samples, language bindings, and API reference documentation for vSphere, VMC, and NSX-T using the VMware REST API

  • PyDrive2

    Google Drive API Python wrapper library. Maintained fork of PyDrive.

  • python-istihza

    İstihza Python Belgeleri, en kapsamlı Türkçe Python belgelendirmesi

  • doorstop

    Requirements management using version control.

  • amazing-github-template

    🚀 Useful README.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub Issues, Pull Requests and Actions templates to jumpstart your projects.

  • AutoDoc-ChatGPT

    AutoDoc-ChatGPT is a Python script that leverages the power of ChatGPT model to automatically generate documentation for any programming language. With AutoDoc-ChatGPT, you can easily generate comprehensive documentation for your codebase.

  • Project mention: Can Code GPT document a python code? | /r/CodeGPT_VSCode | 2023-05-05

    I have been using AutoDoc-ChatGPT (https://github.com/awekrx/AutoDoc-ChatGPT) to document python code. For this I need to use either command line or paste the code to be documented in another script, which can get a bit troublesome.

  • shtab

    ↔️ Automagic shell tab completion for Python CLI applications

  • f4pga

    FOSS Flow For FPGA

  • Project mention: Show HN: Atopile – Design circuit boards with code | news.ycombinator.com | 2024-02-05
  • awesome-n64-development

    A curated list of Nintendo 64 development resources including toolchains, documentation, emulators, example code, and more

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub logo
NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).

Python Documentation related posts

Index

What are some of the best open-source Documentation projects in Python? This list will help you:

Project Stars
1 professional-programming 45,155
2 cheat.sh 37,443
3 wtfpython 35,051
4 MkDocs 18,257
5 sphinx 6,028
6 documentation 5,083
7 pdoc 1,807
8 readme-ai 1,225
9 apispec 1,132
10 pdoc 1,088
11 pyment 876
12 portray 859
13 Pycco 839
14 videos 808
15 vsphere-automation-sdk-python 726
16 PyDrive2 527
17 python-istihza 489
18 doorstop 454
19 amazing-github-template 414
20 AutoDoc-ChatGPT 379
21 shtab 339
22 f4pga 311
23 awesome-n64-development 309

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com