Internal ReadTheDocs for Company Project Documentation

May 13th, 2012


ReadTheDocs for Company Project Documentation

Intro
I currently work for a company called CashStar, inc. located in Portland, Maine. We power a platform for retailers to provide eGift Cards using Python/Django. As with most companies, in my experience, documentation is one of those things that is first to be left by the wayside. CashStar is not the exception...but we're taking significant steps to make it better, please Read on...
Why does it...
Read more

Configuring an internal ReadTheDocs

May 1st, 2012


Project Overview


ReadTheDocs application to serve project documentation
Simple and Straightforward, minimal overhead
Modified to point to our domain, not readthedocs
Restricted Public Access




Technology Overview
ReadTheDocs comes with the following technology stack:


Varnish
Nginx
gunicorn
postgres
python/django
solr (haystack search)
Chef


In an effort to align with some of the technologies I have some experience with, I modified the technology stack slightly, its now as follows:


supervisor
gunicorn
memcached
nginx
python/django
mysql
whoosh (haystack search)
fabric




Key Functionality Overview

System Message: WARNING/2 (<string>,...
Read more