Solutions like Dependabot or Renovate update but don't merge dependencies. You need to do it manually while it could be fully automated! Add a Merge Queue to your workflow and stop caring about PR management & merging. Try Mergify for free. Learn more →
Top 23 Python Documentation Projects
-
Project mention: Free Tech Tools and Resources - WinPE Build, Cheatsheet Tool, PW Recovery & More | /r/msp | 2023-07-27
Cheat.sh provides unified access to the world's best community-driven documentation repositories. Its simple interface gives access to an impressive range of 56 programming languages, several DBMSes, and over 1000 essential UNIX/Linux commands. Offering StackOverflow-level cheat sheets, it requires no installation and boasts lightning-fast response times. The optional CLI client seamlessly integrates with code editors to eliminate the need for a browser, and the unique 'stealth mode' allows for entirely invisible and silent use. Our appreciation for this recommendation goes to Hoolies.
-
-
Mergify
Updating dependencies is time-consuming.. Solutions like Dependabot or Renovate update but don't merge dependencies. You need to do it manually while it could be fully automated! Add a Merge Queue to your workflow and stop caring about PR management & merging. Try Mergify for free.
-
Also this repo helps https://github.com/charlax/professional-programming
-
Project mention: Creating a knowledge base website for work, do I need a database or can it be only front end designed? | /r/learnprogramming | 2023-07-03
Take a look at https://www.mkdocs.org
-
Project mention: User Guides in Code Documentation: Empowering Users with Usage Instructions | dev.to | 2023-08-20
Sphinx a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is, if you have a directory containing a bunch of reStructuredText or Markdown documents, Sphinx can generate a series of HTML files, a PDF file (via LaTeX), man pages and much more.
-
documentation
The official documentation for Raspberry Pi computers and microcontrollers (by raspberrypi)
You can output video (called DPI) from your gpio with the correct config settings. You would just need hsync, vsync, and 2 color bits (green for video, blue for intensity should give the best image, but feel free to play around with that). Next step it to use level converters, as hooking up TTL directly to the Pi will fry it. https://github.com/raspberrypi/documentation/blob/develop/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc
-
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.
-
Sonar
Write Clean Python Code. Always.. Sonar helps you commit clean code every time. With over 225 unique rules to find Python bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.
-
Author doesn’t mention it but I wonder if tried or considered Nix/NixOS’s reproducible developer environments and ruled them out for any reason. I couldn’t tell from the article if there’s something unique to his requirements that disqualifies them.
-
apispec
A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..
-
Project mention: Asian faiths try to save swastika symbol corrupted by Hitler | news.ycombinator.com | 2022-11-27
Also seen in GitHub in the wild at times. Always brings interesting discussions...
https://github.com/pdoc3/pdoc/issues/87
I've learnt a lot about cultures through those PRs
-
-
-
-
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: To combine or not to combine lxc docker containers, that is the question. | /r/Proxmox | 2023-06-21 -
vsphere-automation-sdk-python
Python samples, language bindings, and API reference documentation for vSphere, VMC, and NSX-T using the VMware REST API
-
PyDrive2 is am open-source python package maintained by the awesome people at Iterative. And it is very easy to install:
-
-
-
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.
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.
-
-
awesome-n64-development
A curated list of Nintendo 64 development resources including toolchains, documentation, emulators, example code, and more
Project mention: Paper Mario PC ports beckon as coder completes full decompilation of the N64 classic | /r/REGames | 2023-04-22See as well: Awesome N64 Development resources
-
InfluxDB
Collect and Analyze Billions of Data Points in Real Time. Manage all types of time series data in a single, purpose-built database. Run at any scale in any environment in the cloud, on-premises, or at the edge.
Python Documentation related posts
- Running Linux on Xilinx / AMD FPGA Softcore Example Design
- User Guides in Code Documentation: Empowering Users with Usage Instructions
- A nice Git beginner's guide.
- Creating a knowledge base website for work, do I need a database or can it be only front end designed?
- Examples with Github Pages?
- best packages for documenting the flow of logic?
- To combine or not to combine lxc docker containers, that is the question.
-
A note from our sponsor - Mergify
blog.mergify.com | 29 Sep 2023
Index
What are some of the best open-source Documentation projects in Python? This list will help you:
Project | Stars | |
---|---|---|
1 | cheat.sh | 36,059 |
2 | wtfpython | 34,288 |
3 | professional-programming | 23,870 |
4 | MkDocs | 17,101 |
5 | sphinx | 5,651 |
6 | documentation | 4,926 |
7 | pdoc | 1,632 |
8 | nix.dev | 1,474 |
9 | apispec | 1,051 |
10 | pdoc | 1,010 |
11 | portray | 848 |
12 | pyment | 846 |
13 | Pycco | 832 |
14 | videos | 689 |
15 | vsphere-automation-sdk-python | 685 |
16 | PyDrive2 | 439 |
17 | doorstop | 410 |
18 | TheHiveDocs | 389 |
19 | amazing-github-template | 369 |
20 | AutoDoc-ChatGPT | 340 |
21 | dexy | 308 |
22 | shtab | 283 |
23 | awesome-n64-development | 281 |