Create host and browse documentation
Today i am telling a place where you can create host and browse documentation. Read the docs is a website where you can create host and browse documentation. Read the Docs simplifies software documentation by automating building, versioning, and hosting of your docs for you. Think of it as Continuous Documentation. Official website is http://readthedocs.org/
Why Use Read the docs
- Never out of syncWhenever you push code to your favorite version control system, whether that is Git, Mercurial, Bazaar, or Subversion, Read the Docs will automatically build your docs so your code and documentation are always up-to-date.
- Free and open sourceRead the Docs is free and open source and hosts documentation for nearly 100,000 large and small open source projects in almost every human and computer language.
Free docs hosting
Read the Docs will host your documentation for free forever. There are no tricks. Read the Docs help 220,027 open source projects share their docs.
Webhooks
Whenever you push code to your favorite version control system, whether that is Git, Mercurial, Bazaar, or Subversion, Read the Docs will automatically build your docs so your code and documentation are never out of sync.
Multiple formats
Of course Read the Docs build and host your docs for the web, but they are also vieweable as PDFs, as single page HTML, and for eReaders. No additional configuration is required.
Multiple versions
Read the Docs can host and build multiple versions of your docs so having a 1.0 version of your docs and a 2.0 version of your docs is as easy as having a separate branch or tag in your version control system.
Are you new to software documentation or are you looking to use your existing docs with Read the Docs? Learn about documentation authoring tools such as Sphinx and MkDocs to help you create fantastic documentation for your project.
- Getting started: With Sphinx | With MkDocs
- Importing your existing documentation: Import guide
How to use ?
Read official documentation – https://docs.readthedocs.io/en/stable/index.html
Thanks for reading. If you like this post probably you might like my next ones, so please support me by subscribing my blog.
You may like also:
- MQTT | What is MQTT | MQTT in Depth | QoS | FAQs | MQTT Introduction
- Best IoT Visual Programming Tools
