Merge remote-tracking branch 'origin/master' into ads-served-ethically

Author: ericholscher

.gitignore

@@ -15,6 +15,7 @@
 .ropeproject/
 _build
 bower_components/
+contrib/supervisord.log
 deploy/.vagrant
 dist/*
 local_settings.py
@@ -43,3 +44,4 @@ private_*
 readthedocs/htmlcov
 tags
 .python-version
+*.pyo

contrib/readme.rst

@@ -0,0 +1,28 @@
+Running Read the Docs via Supervisord
+=====================================
+
+This is the easiest way to start all of the commands you'll need for development
+in an environment relatively close to the production evironment. All you need is
+``supervisord`` and ``redis-server``. Installation of ``redis-server`` is
+outside the scope of this documentation, but once installed, all you need to run
+from ``supervisord`` is::
+
+    pip install supervisord
+    cd contrib/
+    supervisord
+
+This will bring up a web instance for the dashboard, a web instance for
+documentation serving, two celery instances, and redis-server. 
+
+If you already are running redis-server, this will complain about the port
+already being in use, but will still load.
+
+Debugging
+---------
+
+To debug, set trace points like normal, with ``pdb``/``ipdb``. Then you can
+connect to the process by bringing it to the foreground::
+
+    supervisorctl fg main
+
+You'll still see logging to STDERR on the main supervisord process page.

contrib/supervisord.conf

@@ -0,0 +1,42 @@
+[supervisord]
+nodaemon = True
+directory = ../
+loglevel = error
+strip_ansi = False
+environment = PYTHONUNBUFFERED=1,READTHEDOCS_INSTANCE=readthedocs.org
+
+[inet_http_server]
+port = 127.0.0.1:9001
+username = 🍔
+password = 🍟
+
+[supervisorctl]
+username = 🍔
+password = 🍟
+
+[rpcinterface:supervisor]
+supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
+
+[program:redis]
+command = redis-server
+directory = ../
+priority = 0
+startretries = 0
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0
+
+[program:main]
+command = python manage.py runserver 8000
+directory = ../
+priority = 100
+stopasgroup = True
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0
+
+[program:celery]
+command = celery worker -A readthedocsinc -Q default,celery,web,builder -l DEBUG -c 2
+directory = ../
+priority = 100
+stopasgroup = True
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0

docs/team.rst

@@ -33,7 +33,7 @@ Members
 ~~~~~~~
 
 * `Eric Holscher <https://github.com/ericholscher>`_ (Pacific Time)
-* `Anthony Johnson <https://github.com/agjohnson>`_ (Pacific Time)
+* `Anthony Johnson <https://github.com/agjohnson>`_ (Mountain Time)
 * `Manuel Kaufmann <https://github.com/humitos>`_ (Central Time)
 * Your Name Here
 
@@ -63,7 +63,7 @@ Members
 ~~~~~~~
 
 * `Eric Holscher <https://github.com/ericholscher>`_ (Pacific Time)
-* `Anthony Johnson <https://github.com/agjohnson>`_ (Pacific Time)
+* `Anthony Johnson <https://github.com/agjohnson>`_ (Mountain Time)
 * `Matt Robenolt <https://github.com/mattrobenolt>`_ (Pacific Time)
 * Your Name Here
 
@@ -108,9 +108,10 @@ Members
 
 * `Eric Holscher <https://github.com/ericholscher>`_
 * `Anthony Johnson <https://github.com/agjohnson>`_
+* `Manuel Kaufmann <https://github.com/humitos>`_
 * `Gregor Müllegger <https://github.com/gregmuellegger>`_
 * `Stein Magnus Jodal <https://github.com/jodal>`_
-* Your Name Here
+* Your name here
 
 Feel free to ask any of us if you have questions or want to join!
 

media/css/readthedocs-doc-embed.css

@@ -8,21 +8,21 @@
 }
 
 .rst-other-versions {
-	text-align: left;
+    text-align: left;
 }
 
 .rst-other-versions a {
-	border: 0;
+    border: 0;
 }
 
 .rst-other-versions dl {
-	margin: 0;
+    margin: 0;
 }
 
 
 /* Fix RTD theme bottom margin */
 .rst-content .line-block {
-	margin-bottom: 24px
+    margin-bottom: 24px
 }
 
 /* Fix for nav bottom padding with flyout */
@@ -134,11 +134,39 @@ div.rtd-pro.alabaster div.rtd-pro-about a {
     border-bottom: 0px;
 }
 
-div.rtd-pro.alabaster div.rtd-pro-about i.fa-info-circle:before {
+div.rtd-pro.alabaster div.rtd-pro-about i.fa-info-circle:before,
+div.rtd-pro.rtd-pro-footer div.rtd-pro-about i.fa-info-circle:before {
     content: "";
     color: #a3a3a3;
 }
 
+/* Hide the "sponsored" note in the left navigation */
+div.rtd-pro-about span {
+    display: none;
+}
+
+/* Footer promos */
+div.rtd-pro.rtd-pro-footer div.rtd-pro-about span {
+    display: inline;
+}
+div.rtd-pro.rtd-pro-footer div.rtd-pro-about {
+    float: none;
+}
+div.rtd-pro.rtd-pro-footer div.rtd-pro-about a {
+    text-decoration: none;
+}
+div.rtd-pro.rtd-pro-footer {
+    text-align: left;
+}
+div.rtd-pro.rtd-pro-footer a.rtd-pro-image-wrapper {
+    float: right;
+    margin-left: 25px;
+}
+
+div.rtd-pro-wrapper {
+    clear: both;
+}
+
 @media (max-width: 768px) {
     div.rst-pro.wy-menu {
         display: none;

readthedocs/core/static-src/core/js/doc-embed/constants.js

@@ -10,4 +10,9 @@ exports.PROMO_SUPPORTED_THEMES = [
     exports.THEME_ALABASTER
 ]
 
+exports.PROMO_TYPES = {
+    LEFTNAV: 'doc',               // Left navigation on documentation pages
+    FOOTER: 'site-footer'         // Footer of documentation pages
+};
+
 module.exports = exports;

readthedocs/core/static-src/core/js/doc-embed/footer.js

@@ -73,7 +73,8 @@ function injectFooter(data) {
             data.promo_data.text,
             data.promo_data.link,
             data.promo_data.image,
-            config.theme
+            config.theme,
+            data.promo_data.display_type
         )
         if (promo) {
             promo.display();