Read the Docs

{{Infobox website

| name = Read the Docs

| logo = frameless

| logo_caption = Read the Docs Logo

| website = {{URL|readthedocs.org}}

| country_of_origin = United States

| founder = Eric Holscher, Anthony Johnson

}}

{{Infobox software

| repo = {{URL|github.com/rtfd/readthedocs.org}}

| programming language = Python

| license = MIT

}}

Read the Docs is an open-sourced free software documentation hosting platform.{{Cite news |url=https://opensource.com/business/16/8/introduction-read-docs |title=Making documentation easy with Read the Docs |work=Opensource.com |access-date=2017-06-08 |language=en}} It generates documentation written with the Sphinx documentation generator, MkDocs,{{Cite web |title=MkDocs |url=https://www.mkdocs.org/ |access-date=2023-09-23 |website=www.mkdocs.org}} or Jupyter Book.{{Cite web |title=Built with Jupyter Book |url=https://jupyterbook.org/en/stable/intro.html |access-date=2023-09-23 |website=jupyterbook.org |language=en}}

History

The site was created in 2010 by Eric Holscher, Bobby Grace, and Charles Leifer.{{Cite web |url=http://ericholscher.com/blog/2010/aug/16/announcing-read-docs/ |author=Eric Holscher |title=Announcing Read The Docs |website=ericholscher.com |language=en |access-date=2017-06-16}}

On March 9, 2011, the Python Software Foundation Board awarded a grant of US$840 to the Read the Docs project for one year of hosting fees.{{Cite web |url=https://pyfound.blogspot.ca/2011/03/psf-funds-readthedocsorg.html |title=PSF Funds readthedocs.org |last=Hellmann |first=Doug |date=2011-03-09 |website=pyfound.blogspot.ca |access-date=2017-12-17}} On November 13, 2017, the Linux Mint project announced that they were moving their documentation to Read the Docs.{{Cite web |url=https://blog.linuxmint.com/?p=3442 |title=Monthly News – November 2017 |date=2017-11-16 |website=The Linux Mint Blog |language=en-US |access-date=2017-12-17}} In 2020, Read the Docs received a $200,000 grant from the Chan Zuckerberg Initiative.{{Cite web |last=Holscher |first=Eric |date=2020-11-19 |title=Announcing Chan Zuckerberg Initiative Grant to Expand the Interoperability of Scientific Documentation |url=https://blog.readthedocs.com/czi-grant-announcement.html |access-date=2022-07-14 |website=Read the Docs Blog |language=en}} For 2021, Read the Docs reported 700 million page views and 196 million unique visitors.{{Cite web |last=Holscher |first=Eric |date=2022-03-21 |title=Read the Docs 2021 Stats |url=https://blog.readthedocs.com/read-the-docs-2021-stats.html |access-date=2022-07-14 |website=Read the Docs Blog |language=en}}

In 2013, a "Write the Docs" conference for Read the Docs users was launched, which has since turned into a generic software-documentation community.{{Cite web |author=Meri Williams |date=2021-02-05 |title=5 things you need to know about growing a tech team under Covid-19 |url=https://www.siliconrepublic.com/advice/scaling-remote-team-recruitment-training |url-status=live |archive-url=https://archive.today/20210826155536/https://www.siliconrepublic.com/advice/scaling-remote-team-recruitment-training |archive-date=2021-08-26 |access-date=2021-08-26 |website=Silicon Republic |language=en }}{{Cite web |author=Matt Asay |date=2021-07-19 |title=Should documentation writers get paid more than developers? |url=https://www.techrepublic.com/index.php/category/2026/index.php/article/should-documentation-writers-get-paid-more-than-developers/ |url-status=live |archive-url=https://archive.today/20210826155122/https://www.techrepublic.com/index.php/category/2026/index.php/article/should-documentation-writers-get-paid-more-than-developers/ |archive-date=2021-08-26 |access-date=2021-08-26 |website=TechRepublic |language=en }}{{cite web |url=http://www.writethedocs.org/origin-story/ |title=Origin Story |website=Write the Docs |accessdate=2017-06-29}} As of 2024, it continues to hold annual global conferences, organize local meetups, and maintain a Slack channel for "people who care about documentation."{{Cite web |title=Welcome to our community! — Write the Docs |url=https://www.writethedocs.org/ |access-date=2024-11-13 |website=www.writethedocs.org}}

References

External links

{{Official website}}
{{github|rtfd/readthedocs.org|Read the Docs}}`

Category:Application software

Category:Documentation generators

Category:Software using the MIT license

Category:Free software programmed in Python