Read the Docs – online documentation system


Read the Docs

read-the-docs

“Read the docs” is an online system that allows you to create documentation of your system, software, etc. This is a FREE system (although they would like you to contribute to the project in order to help the funding).

Read their getting started guide. This shows that you can get your documentation online within 5 minutes and available to all your users. A very clear and easy to use system, allowing you to import your documents if required.

Formatting the documentation is available in two formats: reStructuredText and Markdown. Markdown is becoming increasingly very popular as it is easy to format text – quickly and used on many systems.

There are some great features of this system:

  • Github and Bitbucket integration
  • Auto-updating
  • Internationalization
  • Canonical URL’s
  • Version control
  • PDF Generation
  • Search
  • Alternative domains (use your own domain name with CNAME support)

Sign up! It’s free and a great, easy to use system

Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. We support webhooks so your docs get built when you commit code. There’s also support for versioning so you can build docs from tags and branches of your code in your repository. A full list of features is available.

via Home | Read the Docs.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s