Software:Read the Docs

From HandWiki
Read the Docs
Read-the-docs.png
Read the Docs Logo
Country of originUnited States
Founder(s)Eric Holscher, Anthony Johnson
Websitereadthedocs.org
Read the Docs
Repositorygithub.com/rtfd/readthedocs.org/
Written inPython
LicenseMIT

Read the Docs is an open-sourced free software documentation hosting platform.[1] It generates documentation written with the Sphinx documentation generator, MkDocs,[2] or Jupyter Book.[3]

History

The site was created in 2010 by Eric Holscher, Bobby Grace, and Charles Leifer.[4]

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.[5] On November 13, 2017, the Linux Mint project announced that they were moving their documentation to Read the Docs.[6] In 2020, Read the Docs received a $200,000 grant from the Chan Zuckerberg Initiative.[7] For 2021, Read the Docs reported 700 million page views and 196 million unique visitors.[8]

In 2013, a "Write the Docs" conference for Read the Docs users was launched, which has since turned into a generic software-documentation community.[9][10][11] As of 2022, it continues to hold annual global conferences, organize local meetups, and maintain a Slack channel for "people who care about documentation."[12]

References

  1. "Making documentation easy with Read the Docs" (in en). Opensource.com. https://opensource.com/business/16/8/introduction-read-docs. 
  2. "MkDocs". https://www.mkdocs.org/. 
  3. "Built with Jupyter Book" (in en). https://jupyterbook.org/en/stable/intro.html. 
  4. Eric Holscher. "Announcing Read The Docs" (in en). http://ericholscher.com/blog/2010/aug/16/announcing-read-docs/. 
  5. Hellmann, Doug (2011-03-09). "PSF Funds readthedocs.org". https://pyfound.blogspot.ca/2011/03/psf-funds-readthedocsorg.html. 
  6. "Monthly News – November 2017" (in en-US). 2017-11-16. https://blog.linuxmint.com/?p=3442. 
  7. Holscher, Eric (2020-11-19). "Announcing Chan Zuckerberg Initiative Grant to Expand the Interoperability of Scientific Documentation" (in en). https://blog.readthedocs.com/czi-grant-announcement.html. 
  8. Holscher, Eric (2022-03-21). "Read the Docs 2021 Stats" (in en). https://blog.readthedocs.com/read-the-docs-2021-stats.html. 
  9. Meri Williams (2021-02-05). "5 things you need to know about growing a tech team under Covid-19" (in en). https://www.siliconrepublic.com/advice/scaling-remote-team-recruitment-training. 
  10. Matt Asay (2021-07-19). "Should documentation writers get paid more than developers?" (in en). https://www.techrepublic.com/index.php/category/2026/index.php/article/should-documentation-writers-get-paid-more-than-developers/. 
  11. "Origin Story". http://www.writethedocs.org/origin-story/. Retrieved 2017-06-29. 
  12. "Welcome to our community! — Write the Docs". https://www.writethedocs.org/. 

External links