Merge tag '5.4.0' into rel

Author: stsewd

.travis.yml

@@ -10,7 +10,7 @@ addons:
 jobs:
   include:
     - python: 3.6
-      env: TOXENV=py36,codecov TOX_POSARGS='' ES_VERSION=6.2.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
+      env: TOXENV=py36,codecov TOX_POSARGS='' ES_VERSION=6.5.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
     - python: 3.6
       env: TOXENV=docs
     - python: 3.6

CHANGELOG.rst

@@ -1,3 +1,16 @@
+Version 5.4.0
+-------------
+
+:Date: August 25, 2020
+
+* `@stsewd <https://github.com/stsewd>`__: ES: match version used in production (`#7407 <https://github.com/readthedocs/readthedocs.org/pull/7407>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Advertising docs tweaks (`#7400 <https://github.com/readthedocs/readthedocs.org/pull/7400>`__)
+* `@stsewd <https://github.com/stsewd>`__: Docs: update readthedocs-sphinx-search (`#7399 <https://github.com/readthedocs/readthedocs.org/pull/7399>`__)
+* `@keewis <https://github.com/keewis>`__: document installing into a environment with pinned dependencies (`#7397 <https://github.com/readthedocs/readthedocs.org/pull/7397>`__)
+* `@pyup-bot <https://github.com/pyup-bot>`__: pyup:  Scheduled weekly dependency update for week 32 (`#7377 <https://github.com/readthedocs/readthedocs.org/pull/7377>`__)
+* `@stsewd <https://github.com/stsewd>`__: Builds: store build commands in storage (`#7356 <https://github.com/readthedocs/readthedocs.org/pull/7356>`__)
+* `@stsewd <https://github.com/stsewd>`__: Guide: Cross-referencing with Sphinx (`#7326 <https://github.com/readthedocs/readthedocs.org/pull/7326>`__)
+
 Version 5.3.0
 -------------
 

docs/advertising/advertising-details.rst

@@ -71,8 +71,6 @@ Instead, we target based solely upon:
     targeting by state or by metro area (DMA specifically).
   * We geolocate a user's IP address to a country when a request is made.
 
-Read the Docs uses GeoLite2 data created by `MaxMind <http://maxmind.com>`_.
-
 
 Where ads are shown
 -------------------
@@ -97,6 +95,14 @@ For more details, see the :ref:`Do Not Track section <privacy-policy:Do Not Trac
 of our privacy policy.
 
 
+Ad serving infrastructure
+-------------------------
+
+Our `entire ad server <https://github.com/readthedocs/ethical-ad-server>`_ is open source,
+so you can inspect how we're doing things.
+We believe strongly in open source, and we practice what we preach.
+
+
 Analytics
 ---------
 

docs/advertising/ethical-advertising.rst

@@ -74,6 +74,9 @@ They should run before your content,
 they should take over the page,
 the bigger, weirder, or flashier the better.
 
+.. _fake ad clicks: https://en.wikipedia.org/wiki/Click_fraud
+.. _massive downsides: http://idlewords.com/talks/what_happens_next_will_amaze_you.htm
+
 We opt out
 ~~~~~~~~~~
 
@@ -91,8 +94,6 @@ The ads won't flash or move.
 We run the ads we want to have on our site,
 in a way that makes us feel good.
 
-.. _fake ad clicks: https://en.wikipedia.org/wiki/Click_fraud
-
 Additional details
 ------------------
 
@@ -105,6 +106,8 @@ Additional details
 * Eric Holscher, one of our co-founders
   `talks a bit more <https://www.ericholscher.com/blog/2016/aug/31/funding-oss-marketing-money/>`_
   about funding open source this way on his blog.
+* After proving our ad model as a way to fund open source and building our ad serving infrastructure,
+  we launched the `EthicalAds network <https://www.ethicalads.io>`_ to help other projects be sustainable.
 
 .. _advertising FAQ: https://readthedocs.org/sustainability/advertising/faq/
 
@@ -120,8 +123,6 @@ We hope that others will join us in this mission:
   vote with your dollars and support us in building the ad model we want to exist.
   `Get more information <https://readthedocs.org/sustainability/advertising/>`_ on what we offer.
 
-.. _massive downsides: http://idlewords.com/talks/what_happens_next_will_amaze_you.htm
-
 
 Community Ads
 -------------

docs/conf.py

@@ -110,6 +110,8 @@ def get_version():
 # Activate autosectionlabel plugin
 autosectionlabel_prefix_document = True
 
+numfig = True
+
 # sphinx-notfound-page
 # https://github.com/readthedocs/sphinx-notfound-page
 notfound_context = {

docs/faq.rst

@@ -251,6 +251,23 @@ using a Read the Docs :doc:`config-file/index`.
 .. _pip requirements file: https://pip.pypa.io/en/stable/user_guide.html#requirements-files
 
 
+I need to install a package in a environment with pinned versions
+-----------------------------------------------------------------
+
+To ensure proper installation of a python package, the ``pip`` :ref:`install method <config-file/v2:python.install>` will automatically upgrade every dependency to its most recent version in case they aren't pinned by the package definition.
+If instead you'd like to pin your dependencies outside the package, you can add this line to your requirements or environment file (if you are using Conda).
+
+In your ``requirements.txt`` file::
+
+    # path to the directory containing setup.py relative to the project root
+    -e .
+
+In your Conda environment file (``environment.yml``)::
+
+    # path to the directory containing setup.py relative to the environment file
+    -e ..
+
+
 How can I avoid search results having a deprecated version of my docs?
 ----------------------------------------------------------------------