Read the Docs
Flatdoc
Our great sponsors
| Read the Docs | Flatdoc | |
|---|---|---|
| 33 | 1 | |
| 7,865 | 2,676 | |
| 0.4% | - | |
| 9.8 | 0.0 | |
| 3 days ago | 11 months ago | |
| Python | CSS | |
| MIT License | - |
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.
Read the Docs
-
Exploring Django's Third-Party Packages: Top Libraries You Should Know
ReadTheDocs - ReadTheDocs hosts documentation for many Django packages. It provides easy access to comprehensive documentation, including installation instructions, configuration guides, and usage examples.
-
ReadTheDocs Sphinx theme urllib3 related build errors
fixes are here: https://github.com/readthedocs/readthedocs.org/issues/10290
-
Dealing with documentation
Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.
-
Document or Die: The Importance of Writing Things Down in Tech
ReadTheDocs: An open-source platform for creating and hosting documentation, with support for multiple programming languages and integration with version control systems.
-
datadelivery: Providing public datasets to explore in AWS
Well, by now I really invite all the readers to join and read more about the datadelivery Terraform module. There is a huge documentation page hosted on readthedocs with many useful information about how this project can help users on their analytics journey in AWS.
-
Marketing for Developers
ReadTheDocs is a free way to host your open-source documentation.
-
Re-License Vaultwarden to AGPLv3
They are using this infrastructure as the moat. ReadTheDocs is also doing the same thing.
Deploy if you dare: https://github.com/readthedocs/readthedocs.org
-
Yahoo is making a return to search
That "/*/tree" rule means that search engine crawlers are allowed to hit the README file of a repo but effectively NONE of the other files in it.
Which means that if you keep your project documentation on GitHub in a docs/ folder it won't be indexed!
You need to publish it to a separate site via GitHub Pages, or use https://readthedocs.org/
- Como criar e hospedar um site de documentação para o seu projeto usando Hugo e Netlify
-
Setting up a Documentation Website for your Software Project with Hugo and Netlify
Readthedocs + mkdocs: this is a good combination using the free documentation platform Readthedocs. You get a free .readthedocs subdomain, and can also set up a custom domain. I use it for the Minicli docs, overall a good solution but I find it to be a bit flaky sometimes, specially when there are updates.
What are some alternatives?
MkDocs - Project documentation with Markdown.
mkdocs-material - Documentation that simply works
just-the-docs - A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
MdWiki
Hugo - The world’s fastest framework for building websites.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
sphinx - The Sphinx documentation generator
Docusaurus - Easy to maintain open source documentation websites.
daux.io - Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
docsify - 🃏 A magical documentation site generator.
markdown-tree - A Sinatra script to serve a hierarchy / tree directory of markdown files. Use intended for small sites built in markdown.