MkDocs
pdoc
MkDocs | pdoc | |
---|---|---|
118 | 10 | |
19,802 | 2,023 | |
0.9% | 1.5% | |
7.9 | 8.3 | |
3 months ago | 6 days ago | |
Python | Python | |
BSD 2-clause "Simplified" License | MIT No Attribution |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
MkDocs
-
How to Create and Publish a Python Package on PyPI 🐍
The original mkdocs uses a Python package for its installer, so you can just pip install mkdocs, mkdocs new ., and then mkdocs build to convert markdown files into HTML.
-
Docusaurus – Build optimized websites quickly, focus on your content
If you don't like to run javascript outside of a browser, MkDocs is a great Python-based alternative: https://www.mkdocs.org/
-
Why I Prefer RST to Markdown
I like Markdown because it's simple and doesn't give me that many headaches.
You know what I don't like? HTML, for user submitted content in particular. The mess I've seen, after someone opted for using HTML for messages in a system, because that's what JS based editors were available for at the time. Endless need to work against XSS, with more and more incremental updates needed to the sanitization logic, some of which broke the presentation of the data in the DB.
Never again. Markdown, BBCode, anything but that.
As for docs? Currently just some Markdown, because that's what GitHub, GitLab, Gitea and others all know how to render.
Maybe something like https://www.mkdocs.org/ for the more standalone use cases.
-
Why Docs-as-Code is the Key to Better Software Documentation
Developing the documentation website using an open-source static site generator like Sphinx or MkDocs to build the files locally through the command line, rather than using a commercial program.
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
pdoc
-
How to Write Impeccably Clean Code That Will Save Your Sanity
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.
-
what's a good documentation platform that you guys would recommend?
I’ve used sphinx extensively and though it is one of the standards and does a ton, I do not like or recommend it. Personally, I realllly like pdoc for its simplicity. Do not confused pdoc with pdoc3
- The Slow March of Progress in Programming Language Tooling
-
What is it that makes Rust documentation so special, and how could we make that lightning strike twice in other languages?
Anyway, this is all my opinion. And a lot of it is based on reflecting on my own experience. I have no idea how well it generalizes. I have given this topic a lot of thought though, and have even written documentation generators for other ecosystems because I thought the other choices were bad enough to warrant spending a few weeks on such a tool.
-
Bombsquad 1.6.11 (20538, 2022-03-23) released
Documentation is now generated using pdoc https://pdoc.dev. Thanks Dliwk!! (I'll get it wired up to auto-update to a webpage soon).
-
My first open-source package on PyPI: `spectrumdevice`, a high-level, object-oriented library for controlling Spectrum Instruments digitisers. A bit of a niche one!
There's a comprehensive README.md with installation and Quickstart information on GitHub, and reference documentation (auto generated by pdoc) on GitHub Pages.
-
Mitmproxy 7.0
Our main docs are built with Hugo (https://github.com/mitmproxy/mitmproxy/tree/main/docs). For our API docs we use pdoc (https://pdoc.dev), which integrates well with most static site generators. pdoc is also maintained by us. :)
-
Things I Wish I Knew as a New Python User
PEP 257 and a few others define "docstrings". Leverage them to make full use of autodoc tools. pdoc is a pretty fun tool that "just works". Build good habits from the start. Projects that have great documentation are just more attractive to me. If I come across a project that seems to do what I need, but has crappy documentation, I keep looking.
-
Show HN: Pdoc, a lightweight Python API documentation generator
Hi HN! Some of you may remember @BurntSushi's pdoc tool, a lightweight alternative to Sphinx. We're a bit in an unfortunate situation with a hostile work assuming our name [1], but I figured that we shouldn't give in and continue the legacy of that tool. Long story short, we have just published a major new "modern Python 3" release, which hopefully makes pdoc a really compelling option again. :-)
[1] https://github.com/mitmproxy/pdoc#pdoc-vs-pdoc3
What are some alternatives?
sphinx - The Sphinx documentation generator
DocFX - Static site generator for .NET API documentation.
Python Cheatsheet - All-inclusive Python cheatsheet
Hugo - The world’s fastest framework for building websites.
Pycco - Literate-style documentation generator.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
pyment - Format and convert Python docstrings and generates patches
Docusaurus - Easy to maintain open source documentation websites.
mdutils - Python package contains a set of basic tools that can help to create a markdown file.
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
pdocs - A simple program and library to auto generate API documentation for Python modules.