travis fixes

Author: tapaswenipathak

CHANGELOG.rst

@@ -1,3 +1,68 @@
+Version 3.8.0
+-------------
+
+:Date: October 09, 2019
+
+* `@stsewd <http://github.com/stsewd>`__: Update doccs version detail (api v3) (`#6259 <https://github.com/readthedocs/readthedocs.org/pull/6259>`__)
+* `@stsewd <http://github.com/stsewd>`__: Merge #6176 to master (`#6258 <https://github.com/readthedocs/readthedocs.org/pull/6258>`__)
+* `@humitos <http://github.com/humitos>`__: Remove privacy_level field from APIv3 (`#6257 <https://github.com/readthedocs/readthedocs.org/pull/6257>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Redirect /projects/ URL to /dashboard/ (`#6255 <https://github.com/readthedocs/readthedocs.org/pull/6255>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Allow project badges for private version (`#6252 <https://github.com/readthedocs/readthedocs.org/pull/6252>`__)
+* `@pyup-bot <http://github.com/pyup-bot>`__: pyup:  Scheduled weekly dependency update for week 40 (`#6251 <https://github.com/readthedocs/readthedocs.org/pull/6251>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Add note about specifying dependencies (`#6248 <https://github.com/readthedocs/readthedocs.org/pull/6248>`__)
+* `@stsewd <http://github.com/stsewd>`__: Add pub_date to project admin (`#6244 <https://github.com/readthedocs/readthedocs.org/pull/6244>`__)
+* `@humitos <http://github.com/humitos>`__: Do not use --cache-dir for pip if CLEAN_AFTER_BUILD is enabled (`#6239 <https://github.com/readthedocs/readthedocs.org/pull/6239>`__)
+* `@stsewd <http://github.com/stsewd>`__: Update pytest (`#6233 <https://github.com/readthedocs/readthedocs.org/pull/6233>`__)
+* `@iambenzo <http://github.com/iambenzo>`__: remove /projects/ (`#6228 <https://github.com/readthedocs/readthedocs.org/pull/6228>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Initial stub of proxito (`#6226 <https://github.com/readthedocs/readthedocs.org/pull/6226>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Improve the version listview (`#6224 <https://github.com/readthedocs/readthedocs.org/pull/6224>`__)
+* `@stsewd <http://github.com/stsewd>`__: Override production media artifacts on test (`#6220 <https://github.com/readthedocs/readthedocs.org/pull/6220>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Customize default build media storage for the FS (`#6215 <https://github.com/readthedocs/readthedocs.org/pull/6215>`__)
+* `@agjohnson <http://github.com/agjohnson>`__: Release 3.7.5 (`#6214 <https://github.com/readthedocs/readthedocs.org/pull/6214>`__)
+* `@stsewd <http://github.com/stsewd>`__: Remove dead code (`#6213 <https://github.com/readthedocs/readthedocs.org/pull/6213>`__)
+* `@stsewd <http://github.com/stsewd>`__: Only use the sphinx way to mock (`#6212 <https://github.com/readthedocs/readthedocs.org/pull/6212>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Only Build Active Versions from Build List Page Form (`#6205 <https://github.com/readthedocs/readthedocs.org/pull/6205>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Make raw_config private (`#6199 <https://github.com/readthedocs/readthedocs.org/pull/6199>`__)
+* `@Iamshankhadeep <http://github.com/Iamshankhadeep>`__: moved expandable_fields to meta class (`#6198 <https://github.com/readthedocs/readthedocs.org/pull/6198>`__)
+* `@stsewd <http://github.com/stsewd>`__: Put view under login (`#6193 <https://github.com/readthedocs/readthedocs.org/pull/6193>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove pie-chart from search analytics page (`#6192 <https://github.com/readthedocs/readthedocs.org/pull/6192>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor SearchAnalytics view (`#6190 <https://github.com/readthedocs/readthedocs.org/pull/6190>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor ProjectRedirects views (`#6187 <https://github.com/readthedocs/readthedocs.org/pull/6187>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor ProjectTranslations views (`#6185 <https://github.com/readthedocs/readthedocs.org/pull/6185>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor ProjectNotications views (`#6183 <https://github.com/readthedocs/readthedocs.org/pull/6183>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor views ProjectUsers (`#6178 <https://github.com/readthedocs/readthedocs.org/pull/6178>`__)
+* `@humitos <http://github.com/humitos>`__: Create subproject relationship via APIv3 endpoint (`#6176 <https://github.com/readthedocs/readthedocs.org/pull/6176>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor views ProjectVersion (`#6175 <https://github.com/readthedocs/readthedocs.org/pull/6175>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Add terms of service (`#6174 <https://github.com/readthedocs/readthedocs.org/pull/6174>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Document connected account permissions (`#6172 <https://github.com/readthedocs/readthedocs.org/pull/6172>`__)
+* `@stsewd <http://github.com/stsewd>`__: Refactor views projects (`#6171 <https://github.com/readthedocs/readthedocs.org/pull/6171>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Optimize json parsing (`#6160 <https://github.com/readthedocs/readthedocs.org/pull/6160>`__)
+* `@humitos <http://github.com/humitos>`__: APIv3 endpoint: allow to modify a Project once it's imported (`#5952 <https://github.com/readthedocs/readthedocs.org/pull/5952>`__)
+
+Version 3.7.5
+-------------
+
+:Date: September 26, 2019
+
+* `@davidfischer <http://github.com/davidfischer>`__: Remove if storage blocks (`#6191 <https://github.com/readthedocs/readthedocs.org/pull/6191>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Update security docs (`#6179 <https://github.com/readthedocs/readthedocs.org/pull/6179>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Add the private spamfighting module to INSTALLED_APPS (`#6177 <https://github.com/readthedocs/readthedocs.org/pull/6177>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Document connected account permissions (`#6172 <https://github.com/readthedocs/readthedocs.org/pull/6172>`__)
+* `@stsewd <http://github.com/stsewd>`__: Require login for old redirect (`#6170 <https://github.com/readthedocs/readthedocs.org/pull/6170>`__)
+* `@humitos <http://github.com/humitos>`__: Remove old and unused code (`#6167 <https://github.com/readthedocs/readthedocs.org/pull/6167>`__)
+* `@stsewd <http://github.com/stsewd>`__: Clean up views (`#6166 <https://github.com/readthedocs/readthedocs.org/pull/6166>`__)
+* `@stsewd <http://github.com/stsewd>`__: Update docs for sharing (`#6164 <https://github.com/readthedocs/readthedocs.org/pull/6164>`__)
+* `@pyup-bot <http://github.com/pyup-bot>`__: pyup:  Scheduled weekly dependency update for week 36 (`#6158 <https://github.com/readthedocs/readthedocs.org/pull/6158>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Remove PR Builder Project Idea from RTD GSoC Docs (`#6147 <https://github.com/readthedocs/readthedocs.org/pull/6147>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Serialize time in search queries properly (`#6142 <https://github.com/readthedocs/readthedocs.org/pull/6142>`__)
+* `@humitos <http://github.com/humitos>`__: Allow to extend DomainCreate view (`#6139 <https://github.com/readthedocs/readthedocs.org/pull/6139>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Integration Re-sync Bug Fix (`#6124 <https://github.com/readthedocs/readthedocs.org/pull/6124>`__)
+* `@stsewd <http://github.com/stsewd>`__: Don't log BuildEnvironmentWarning as error (`#6112 <https://github.com/readthedocs/readthedocs.org/pull/6112>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Add Search Guide (`#6101 <https://github.com/readthedocs/readthedocs.org/pull/6101>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Add PR Builder guide to docs (`#6093 <https://github.com/readthedocs/readthedocs.org/pull/6093>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Record search queries smartly (`#6088 <https://github.com/readthedocs/readthedocs.org/pull/6088>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove 'highlight' URL param from search results (`#6087 <https://github.com/readthedocs/readthedocs.org/pull/6087>`__)
+
 Version 3.7.4
 -------------
 

common

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -W --keep-going
+SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build

docs/Makefile

@@ -0,0 +1,54 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Comment: GPGTools - http://gpgtools.org
+
+mQINBFqNz1ABEADvgtp3LT1pV5wuTyBPaKrbWBFj10eKyQ15wfgyc2RR6Ix5QnBo
+6BcJ4fpgBhSwlngsrm0WU5kI/jH7ySwzbDpYCRiLvGJx+pEYLuBBOSm6r5M1N+FV
+xq3ShT4mHXhwPS1mKf9Xe+KlMdYa2e5TlBEr+TxGAmFFrOLjPxw6IDHgP3MVidr2
+iHA2PAATl6H9ZYvNzLkI2sP7h0V1/ADd43YpAK4yk6gdVjype5ez8lmoxDKNabMt
+dSfdOup8zy/fbC5KlxqrT9hHBkYfQWDLWXWcDW111q+ZvncujCrpONaY86bcQ3nn
+QgkeWCwj254vvqsrygEU93reC2onWaROUKoLlX1/1m2k2X3qze/hJRFZaljXVPKH
+jV/5q88EbjSUDgY5v9mdX8jhJAukx9HkOFdkMSh3RBgu1r+UPnCNd9K4T2nN0LBL
+c9NTG0HW7Di5ivEVq74SqDIeiVeOrfY/B6pRuUm/kNPcvZ+ZQPeNk6JUMqEemO9Q
+h0VHSkgkhCPWPO9c9wWJz7O6y6vXgsFG7BZg7mTVOiKbdgneGo/rKRvuBlQ7hCvP
+PklwyRn90SJSgv7NF6HMm4TA1R9mzp+90oXjrDXARXmGTsPtcDXFv7xqpK1+Mfcn
+ajEJYdIRNWVgx0E2RzHRipdG5MIQ5Plf4/GasVHl71nMGY06oIu1T+44MQARAQAB
+tFpSZWFkIHRoZSBEb2NzIFNlY3VyaXR5IFRlYW0gKGh0dHBzOi8vcmVhZHRoZWRv
+Y3Mub3JnL3NlY3VyaXR5LykgPHNlY3VyaXR5QHJlYWR0aGVkb2NzLm9yZz6JAk4E
+EwEIADgWIQRq+P453S2vjKvMbGn+75/C3SHScQUCWo3PUAIbAwULCQgHAgYVCgkI
+CwIEFgIDAQIeAQIXgAAKCRD+75/C3SHScYMMD/4z0TN08oJ57Krg+UODXPsT9U3l
+8fyKHhe6fJCTt5GQiWwBbkfa4M0YcxemIJGdgF1DpdSteWIL0tCwXbxHph+keYlg
+z+EmF+W7OlnwbmtDx/Rj9VNdzf636DkMusTQzYEB/+FdN4LtMVq7Al4CZ2Ca82F8
+h0TLceh2bRgNjeWPuAMj7kS8tw3D9LmYA8d8Lv2c2jN7ba9p+QNKdSa4ErdJ0kbz
+CSFcABPfc+LlYWFbm5j1ggzTONgR9R27mpAGMAtgSeAtxXLU0sQfLtCNaVkRyJ3C
+s0awUvJCuq11YUPjz4HAcTWM4baAxK5LliEDOdaOlTK0q8T0sPP+SWt5JRL6/Xc3
+SwaXnVfzzZyeaSmRGEHmGQYBTB3WMUcH1RNH6uhNPCF4x3t0jOHWP7Eka4B9IdfE
+cd+GDwqTKCHyddh8yUzTrmlSbdO7iuel6WVN0Xo1xzVrLUKpgDvB0UuPQXlxDLUc
+WVrKv9rcyDVGVpDjQSQ4l191NDzlfzmDFkZ69Qe3E5Ir8oWBCMtHX3C99ocIcbR3
+3mqOio2/QQCJzrMOWxgauF/q4JMKQRj5Qq8US2U32xlPzB8O09z1e3kUOEy4gbwE
+6LVMj6vxJqjV8/4AOcocGgJKLLC9nqhf2sq5zA4TjI7lI25pgDDYozaLF2ss5nk3
+t9hQmI5Q0MXGSsflAbkCDQRajc9QARAA30mNh2QaDVLcHEfJ9QKfqRfY3ddG6s6F
+AHLR7mQ2tmO7ygzxgEcM7+7W+lmc9L+mZ5WutK5PIae/MpAgOo220079aW3em2sz
++dIHdSE7CaajUahQaPqLY6W0bbZloGGDetPtOMKBTI1HtSNyKIsULsbyUA1SsEFn
+aWtOof1MqqVQvYDwwwRj6T+DHtV17yO33v98k01Nx1SSThVY9wQ4MOZDBOAqWhie
+iboDssrvtVZZihbQ9LM8TH/l81auodBDpp96tgWguzjM4eyutaYZ6ZOLhfVUuEX+
+gEqqJ7alXfDhh3NZUMHZ0SHVII7u7nqciTo7NS9rxBXfdGlKmC/9Z3ehIXSpCnPY
+JO42qMjPVM5/QDoeK9BWWX3rXmwnNzqK0D4L7zK/cVnt2q9EqPCUJgOITJWEGc9G
+crO0ni/8M+BuhO/4MeJJtrPtmq1b1BoeuYBzf1M7ARtnvtC5hLLrtxiy4UANlwSm
+HFcIEt5UViwEqRuQWr5ZO3mwaJP2R/foDHww7JYEqJ/GFI5RpT+3LWT5FXPC1QvU
+sbewD+ZmLSfifhC0WUzF002eadgXNyXSZKAirM8+yELM4xZAs0pJVlKVFRnis0OL
+Wxdzthp2gTg+agtMoz27belxVUEmRK9GDaXi9XtJSooSglt0xlTimgB40nDPniVB
+4h5S/gHsg8cAEQEAAYkCNgQYAQgAIBYhBGr4/jndLa+Mq8xsaf7vn8LdIdJxBQJa
+jc9QAhsMAAoJEP7vn8LdIdJxwswP/0oGlxUJZhDG8yCbTTTvxvKXd02AXw/GQKrq
+ptrLEXbhko6TOuZolEWsRrc1ObMiky97CicqQthg22Kf1K7g2UNlPS4LFtTrPXKL
+9iJMAgms0a0ul3cHqQh2XiuGc1bfDuGyNe/nE5/uvgpjxg0hvvBH/5xuiaMkf+gZ
+nJjF2ZcXm6a17MCuAcw/siox1/PeXn0At/wzOWD9qONg+BI/QUynzcSMg/coBe7V
+hUX1LU02n6laBwuQ6Q0KoD6CP43seYv3JaPyVP7+IkhtH/RDm8q3vs0qLpEBrJIb
+vBYBXLtyoGHxTkWueou0Ur1j2lLUMqnQkq5NAsckSfHtZEdPDy6T3NHMfVRmnXnW
+m/GM3BDE7DFe5BBYb+vJS4/JHNDoSpk+jNezaf3hdx9+fh2DIoL84fs1FRRAl3Od
+6LWPAt3twOQLS0KsQh0GSIZ+zdJf3xvlZ4ixAaPB4iAF8bXYzvsODN3LRQIGhet2
+NzjD41f5IrAlG/qFiC6s/YLj1DWanLw2nTzSi4x3v0Gc4DEXPebB3KvaNEmqoKGP
+5aXa9IPbvzEVCX82qjeqCPYAsYVOBQnFEAcnkrQ76363oJTeTHxK7kgewS2YCVyy
+7wVinR8eyrs+3AWrZ5Op817HgxGvAVDGOEK+1OX9g1wt+IdxX00s85/T+Zk9RF6H
+wtRaD9li
+=LjIC
+-----END PGP PUBLIC KEY BLOCK-----

docs/_static/images/guides/github-build-status-reporting.gif

@@ -227,6 +227,35 @@ Project create
     :statuscode 400: Some field is invalid
 
 
+Project update
+++++++++++++++
+
+.. http:patch:: /api/v3/projects/(string:project_slug)/
+
+    Update an existing project.
+
+    **Example request**:
+
+    .. sourcecode:: bash
+
+        $ curl \
+          -X PATCH \
+          -H "Authorization: Token <token>" https://readthedocs.org/api/v3/projects/pip/ \
+          -H "Content-Type: application/json" \
+          -d @body.json
+
+    The content of ``body.json`` is like,
+
+    .. sourcecode:: json
+
+        {
+            "name": "New name for the project",
+            "default_version": "v0.27.0"
+        }
+
+    :statuscode 204: Updated successfully
+
+
 Versions
 ~~~~~~~~
 
@@ -301,7 +330,6 @@ Version detail
             "ref": "19.0.2",
             "built": true,
             "active": true,
-            "uploaded": true,
             "type": "tag",
             "last_build": "{BUILD}",
             "downloads": {
@@ -320,29 +348,21 @@ Version detail
             }
         }
 
-    :>json integer id: ID for this version on the database
-    :>json string slug: The slug for this version
-    :>json string verbose_name: The name of the version
-    :>json string identifier: A version control identifier for this version (eg. the commit hash of the tag)
-    :>json string ref: tag or branch pointed by this version (available only when version is ``stable`` or ``latest``)
-    :>json string built: Whether this version has been built
-    :>json string active: Whether this version is active
-    :>json string type: The type of this version (typically "tag" or "branch")
-    :>json string last_build: Build object representing the last build of this version
-    :>json array downloads: URLs to downloads of this version's documentation
+    :>json string ref: the version slug where the ``stable`` version points to.
+                       ``null`` when it's not the stable version.
+    :>json boolean built: the version has at least one successful build.
 
-    :requestheader Authorization: token to authenticate.
-
-    :statuscode 200: Success
-    :statuscode 404: There is no ``Version`` with this slug for this project
+    :query string expand: allows to add/expand some extra fields in the response.
+                          Allowed values are ``last_build`` and ``last_build.config``.
+                          Multiple fields can be passed separated by commas.
 
 
 Version update
 ++++++++++++++
 
 .. http:patch:: /api/v3/projects/(string:project_slug)/version/(string:version_slug)/
 
-    Edit a version.
+    Update a version.
 
     **Example request**:
 
@@ -355,7 +375,7 @@ Version update
 
     :requestheader Authorization: token to authenticate.
 
-    :statuscode 204: Edited successfully
+    :statuscode 204: Updated successfully
     :statuscode 400: Some field is invalid
     :statuscode 401: Not valid permissions
     :statuscode 404: There is no ``Version`` with this slug for this project
@@ -532,6 +552,34 @@ This allows for documentation projects to share a search index and a namespace o
 but still be maintained independently.
 See :doc:`/subprojects` for more information.
 
+
+Subproject details
+++++++++++++++++++
+
+
+.. http:get:: /api/v3/projects/(str:project_slug)/subprojects/(str:alias_slug)/
+
+    Retrieve details of a subproject relationship.
+
+    **Example request**:
+
+    .. sourcecode:: bash
+
+        $ curl -H "Authorization: Token <token>" https://readthedocs.org/api/v3/projects/pip/subprojects/subproject-alias/
+
+    **Example response**:
+
+    .. sourcecode:: json
+
+        {
+            "alias": "subproject-alias",
+            "child": ["PROJECT"],
+            "_links": {
+                "parent": "/api/v3/projects/pip/"
+            }
+        }
+
+
 Subprojects listing
 +++++++++++++++++++
 
@@ -554,15 +602,64 @@ Subprojects listing
             "count": 25,
             "next": "/api/v3/projects/pip/subprojects/?limit=10&offset=10",
             "previous": null,
-            "results": ["PROJECT"]
+            "results": ["SUBPROJECT RELATIONSHIP"]
         }
 
-    :>json integer count: total number of projects.
-    :>json string next: URI for next set of projects.
-    :>json string previous: URI for previous set of projects.
-    :>json array results: array of ``project`` objects.
 
-    :requestheader Authorization: token to authenticate.
+Subproject create
++++++++++++++++++
+
+
+.. http:post:: /api/v3/projects/(str:project_slug)/subprojects/
+
+    Create a subproject relationship between two projects.
+
+    **Example request**:
+
+    .. sourcecode:: bash
+
+        $ curl \
+          -X POST \
+          -H "Authorization: Token <token>" https://readthedocs.org/api/v3/projects/pip/subprojects/ \
+          -H "Content-Type: application/json" \
+          -d @body.json
+
+    The content of ``body.json`` is like,
+
+    .. sourcecode:: json
+
+        {
+            "child": "subproject-child-slug",
+            "alias": "subproject-alias"
+        }
+
+    **Example response**:
+
+    `See Subproject details <#subproject-details>`_
+
+    :>json string child: slug of the child project in the relationship.
+    :>json string alias: optional slug alias to be used in the URL (e.g ``/projects/<alias>/en/latest/``).
+                         If not provided, child project's slug is used as alias.
+
+    :statuscode 201: Subproject created sucessfully
+
+
+Subproject delete
++++++++++++++++++
+
+.. http:delete:: /api/v3/projects/(str:project_slug)/subprojects/(str:alias_slug)/
+
+    Delete a subproject relationship.
+
+    **Example request**:
+
+    .. sourcecode:: bash
+
+        $ curl \
+          -X DELETE \
+          -H "Authorization: Token <token>" https://readthedocs.org/api/v3/projects/pip/subprojects/subproject-alias/
+
+    :statuscode 204: Subproject deleted successfully
 
 
 Translations

docs/_static/images/guides/search-analytics-demo.png

@@ -2,30 +2,42 @@ Sharing
 -------
 
 .. note::
-    This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_.
 
-You can share your project with users outside of your company.
-There are two ways to do this:
+   This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
+
+You can share your project with users outside of your company:
 
 * by sending them a *secret link*,
 * by giving them a *password*.
 
 These methods will allow them to view a specific project inside your company.
 
+Additionally, you can use a HTTP Authorization Header.
+This is useful to have access from a script.
+
 Enabling
 ~~~~~~~~
 
 * Go into your *Project Admin* page and to the *Sharing* menu.
-* Under the *Share with someone new* heading, select the way you prefer (secret link or password), add an expiration date and a *Description* so you remember who you're sharing it with.
+* Under the *Share with someone new* heading, select the way you prefer (secret link, password, or HTTP header token),
+  add an expiration date and a *Description* so you remember who you're sharing it with.
 * Click *Share!* to create.
 * Get the info needed to share your documentation with other users:
 
   * If you have selected secret link, copy the link that is generated
   * In case of password, copy the link and password
+  * For HTTP header token, you need to pass the ``Authorization`` header in your HTTP request.
 
 * Give that information to the person who you want to give access.
 
-.. note:: You can always revoke access in the same panel.
+.. note::
+   
+   You can always revoke access in the same panel.
+
+.. note::
+   
+   Sharing using a password and a HTTP header token are currently in beta.
+   If you want access to these features, email us to [email protected].
 
 Effects
 ~~~~~~~
@@ -40,6 +52,17 @@ Password
 ********
 
 Once the person you send the link to clicks on the link, they will see
-a *Authorization required* page asking them for the password you
+an *Authorization required* page asking them for the password you
 generated. When the user enters the password, they will have access to
 view your project.
+
+HTTP Authorization Header
+*************************
+
+You need to send the ``Authorization`` header with the token on each HTTP request.
+The header has the form ``Authorization: Token <ACCESS_TOKEN>``.
+For example:
+
+.. prompt:: bash $
+   
+   curl -H "Authorization: Token 19okmz5k0i6yk17jp70jlnv91v" https://docs.example.com/en/latest/example.html