Skip to content

Commit d46e417

Browse files
committed
Merge branch 'master' into refactor-automation-rules
2 parents a6bcbbb + d44c700 commit d46e417

File tree

105 files changed

+2221
-783
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+2221
-783
lines changed

.circleci/config.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ jobs:
66
- image: 'cimg/python:3.6'
77
environment:
88
TOX_POSARGS: ''
9-
- image: 'docker.elastic.co/elasticsearch/elasticsearch:6.8.12'
9+
- image: 'docker.elastic.co/elasticsearch/elasticsearch:7.9.2'
1010
name: search
11+
environment:
12+
discovery.type: single-node
1113
steps:
1214
- checkout
1315
- run: git submodule sync

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ media/pdf
3939
media/static
4040
/static
4141
node_modules
42+
nodeenv
4243
readthedocs/rtd_tests/builds
4344
readthedocs/rtd_tests/tests/builds
4445
user_builds

CHANGELOG.rst

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,117 @@
1+
Version 5.8.4
2+
-------------
3+
4+
:Date: January 12, 2021
5+
6+
* `@pyup-bot <https://github.com/pyup-bot>`__: pyup: Scheduled weekly dependency update for week 02 (`#7818 <https://github.com/readthedocs/readthedocs.org/pull/7818>`__)
7+
* `@stsewd <https://github.com/stsewd>`__: List SYNC_VERSIONS_USING_A_TASK flag in the admin (`#7802 <https://github.com/readthedocs/readthedocs.org/pull/7802>`__)
8+
* `@ericholscher <https://github.com/ericholscher>`__: Update build concurrency numbers for Business (`#7794 <https://github.com/readthedocs/readthedocs.org/pull/7794>`__)
9+
* `@stsewd <https://github.com/stsewd>`__: Sphinx: use html_baseurl for setting the canonical URL (`#7540 <https://github.com/readthedocs/readthedocs.org/pull/7540>`__)
10+
11+
Version 5.8.3
12+
-------------
13+
14+
:Date: January 05, 2021
15+
16+
* `@humitos <https://github.com/humitos>`__: Change query on `send_build_status` task for compatibility with .com (`#7797 <https://github.com/readthedocs/readthedocs.org/pull/7797>`__)
17+
* `@ericholscher <https://github.com/ericholscher>`__: Update build concurrency numbers for Business (`#7794 <https://github.com/readthedocs/readthedocs.org/pull/7794>`__)
18+
* `@pyup-bot <https://github.com/pyup-bot>`__: pyup: Scheduled weekly dependency update for week 01 (`#7793 <https://github.com/readthedocs/readthedocs.org/pull/7793>`__)
19+
* `@timgates42 <https://github.com/timgates42>`__: docs: fix simple typo, tanslations -> translations (`#7781 <https://github.com/readthedocs/readthedocs.org/pull/7781>`__)
20+
* `@ericholscher <https://github.com/ericholscher>`__: Release 5.8.2 (`#7776 <https://github.com/readthedocs/readthedocs.org/pull/7776>`__)
21+
* `@humitos <https://github.com/humitos>`__: Use Python3.7 on conda base environment when using mamba (`#7773 <https://github.com/readthedocs/readthedocs.org/pull/7773>`__)
22+
* `@stsewd <https://github.com/stsewd>`__: Remove domain verify signal and task (`#7763 <https://github.com/readthedocs/readthedocs.org/pull/7763>`__)
23+
* `@stsewd <https://github.com/stsewd>`__: Import page: fix wizard form (`#7702 <https://github.com/readthedocs/readthedocs.org/pull/7702>`__)
24+
* `@ericholscher <https://github.com/ericholscher>`__: Migrate sync_versions from an API call to a task (`#7548 <https://github.com/readthedocs/readthedocs.org/pull/7548>`__)
25+
* `@humitos <https://github.com/humitos>`__: Design document for RemoteRepository DB normalization (`#7169 <https://github.com/readthedocs/readthedocs.org/pull/7169>`__)
26+
27+
Version 5.8.2
28+
-------------
29+
30+
:Date: December 21, 2020
31+
32+
* `@humitos <https://github.com/humitos>`__: Use Python3.7 on conda base environment when using mamba (`#7773 <https://github.com/readthedocs/readthedocs.org/pull/7773>`__)
33+
* `@stsewd <https://github.com/stsewd>`__: Remove domain verify signal and task (`#7763 <https://github.com/readthedocs/readthedocs.org/pull/7763>`__)
34+
* `@humitos <https://github.com/humitos>`__: Register StopBuilder task to be executed by builders (`#7759 <https://github.com/readthedocs/readthedocs.org/pull/7759>`__)
35+
* `@stsewd <https://github.com/stsewd>`__: Footer: remove absolute_uri (`#7758 <https://github.com/readthedocs/readthedocs.org/pull/7758>`__)
36+
* `@stsewd <https://github.com/stsewd>`__: Search: use alias to link to search results of subprojects (`#7757 <https://github.com/readthedocs/readthedocs.org/pull/7757>`__)
37+
* `@stsewd <https://github.com/stsewd>`__: Footer: remove jsonp call (`#7756 <https://github.com/readthedocs/readthedocs.org/pull/7756>`__)
38+
* `@humitos <https://github.com/humitos>`__: Register AutoscaleBuildersTask (`#7755 <https://github.com/readthedocs/readthedocs.org/pull/7755>`__)
39+
* `@saadmk11 <https://github.com/saadmk11>`__: Set The Right Permissions on GitLab OAuth RemoteRepository (`#7753 <https://github.com/readthedocs/readthedocs.org/pull/7753>`__)
40+
* `@stsewd <https://github.com/stsewd>`__: Use lru_cache for caching methods (`#7751 <https://github.com/readthedocs/readthedocs.org/pull/7751>`__)
41+
* `@fabianmp <https://github.com/fabianmp>`__: Allow to add additional binds to Docker build container (`#7684 <https://github.com/readthedocs/readthedocs.org/pull/7684>`__)
42+
43+
Version 5.8.1
44+
-------------
45+
46+
:Date: December 14, 2020
47+
48+
* `@humitos <https://github.com/humitos>`__: Register ShutdownBuilder task (`#7749 <https://github.com/readthedocs/readthedocs.org/pull/7749>`__)
49+
* `@saadmk11 <https://github.com/saadmk11>`__: Use "path_with_namespace" for GitLab RemoteRepository full_name Field (`#7746 <https://github.com/readthedocs/readthedocs.org/pull/7746>`__)
50+
* `@stsewd <https://github.com/stsewd>`__: Features: remove USE_NEW_PIP_RESOLVER (`#7745 <https://github.com/readthedocs/readthedocs.org/pull/7745>`__)
51+
* `@stsewd <https://github.com/stsewd>`__: Version sync: exclude external versions when deleting (`#7742 <https://github.com/readthedocs/readthedocs.org/pull/7742>`__)
52+
* `@stsewd <https://github.com/stsewd>`__: Search: limit number of sections and domains to 10K (`#7741 <https://github.com/readthedocs/readthedocs.org/pull/7741>`__)
53+
* `@stsewd <https://github.com/stsewd>`__: Traffic analytics: don't pass context if the feature isn't enabled (`#7740 <https://github.com/readthedocs/readthedocs.org/pull/7740>`__)
54+
* `@stsewd <https://github.com/stsewd>`__: Analytics: move page views to its own endpoint (`#7739 <https://github.com/readthedocs/readthedocs.org/pull/7739>`__)
55+
* `@stsewd <https://github.com/stsewd>`__: FeatureQuerySet: make check for date inclusive (`#7737 <https://github.com/readthedocs/readthedocs.org/pull/7737>`__)
56+
* `@stsewd <https://github.com/stsewd>`__: Typo: date -> data (`#7736 <https://github.com/readthedocs/readthedocs.org/pull/7736>`__)
57+
* `@saadmk11 <https://github.com/saadmk11>`__: Use remote_id and vcs_provider Instead of full_name to Get RemoteRepository (`#7734 <https://github.com/readthedocs/readthedocs.org/pull/7734>`__)
58+
* `@pyup-bot <https://github.com/pyup-bot>`__: pyup: Scheduled weekly dependency update for week 49 (`#7730 <https://github.com/readthedocs/readthedocs.org/pull/7730>`__)
59+
* `@saadmk11 <https://github.com/saadmk11>`__: Update parts of code that were using the old RemoteRepository model fields (`#7728 <https://github.com/readthedocs/readthedocs.org/pull/7728>`__)
60+
* `@stsewd <https://github.com/stsewd>`__: Builds: don't delete them when a version is deleted (`#7679 <https://github.com/readthedocs/readthedocs.org/pull/7679>`__)
61+
* `@stsewd <https://github.com/stsewd>`__: Sync versions: create new versions in bulk (`#7382 <https://github.com/readthedocs/readthedocs.org/pull/7382>`__)
62+
* `@humitos <https://github.com/humitos>`__: Use `mamba` under a feature flag to create conda environments (`#6815 <https://github.com/readthedocs/readthedocs.org/pull/6815>`__)
63+
64+
Version 5.8.0
65+
-------------
66+
67+
:Date: December 08, 2020
68+
69+
* `@stsewd <https://github.com/stsewd>`__: Update common (`#7731 <https://github.com/readthedocs/readthedocs.org/pull/7731>`__)
70+
* `@stsewd <https://github.com/stsewd>`__: Bitbucket: mainbranch can be None (`#7725 <https://github.com/readthedocs/readthedocs.org/pull/7725>`__)
71+
* `@stsewd <https://github.com/stsewd>`__: Search: use with_positions_offsets term vector for some fields (`#7724 <https://github.com/readthedocs/readthedocs.org/pull/7724>`__)
72+
* `@stsewd <https://github.com/stsewd>`__: Search: filter only active and built versions from subprojects (`#7723 <https://github.com/readthedocs/readthedocs.org/pull/7723>`__)
73+
* `@stsewd <https://github.com/stsewd>`__: Extra features: allow to display them conditionally (`#7715 <https://github.com/readthedocs/readthedocs.org/pull/7715>`__)
74+
* `@humitos <https://github.com/humitos>`__: Define `pre/post_collectstatic` signals and send them (`#7701 <https://github.com/readthedocs/readthedocs.org/pull/7701>`__)
75+
* `@davidfischer <https://github.com/davidfischer>`__: Support the new Google analytics gtag.js (`#7691 <https://github.com/readthedocs/readthedocs.org/pull/7691>`__)
76+
* `@stsewd <https://github.com/stsewd>`__: HTMLFile: remove slug field (`#7680 <https://github.com/readthedocs/readthedocs.org/pull/7680>`__)
77+
* `@stsewd <https://github.com/stsewd>`__: External versions: delete after 3 months of being merged/closed (`#7678 <https://github.com/readthedocs/readthedocs.org/pull/7678>`__)
78+
* `@stsewd <https://github.com/stsewd>`__: Automation Rules: keep history of recent matches (`#7658 <https://github.com/readthedocs/readthedocs.org/pull/7658>`__)
79+
* `@stsewd <https://github.com/stsewd>`__: Search: update to ES 7.x (`#7582 <https://github.com/readthedocs/readthedocs.org/pull/7582>`__)
80+
81+
Version 5.7.0
82+
-------------
83+
84+
:Date: December 01, 2020
85+
86+
* `@davidfischer <https://github.com/davidfischer>`__: Ensure there is space for sidebar ads (`#7716 <https://github.com/readthedocs/readthedocs.org/pull/7716>`__)
87+
* `@humitos <https://github.com/humitos>`__: Install six as core requirement for builds (`#7710 <https://github.com/readthedocs/readthedocs.org/pull/7710>`__)
88+
* `@stsewd <https://github.com/stsewd>`__: Features: increase feature_id max_length (`#7698 <https://github.com/readthedocs/readthedocs.org/pull/7698>`__)
89+
* `@ericholscher <https://github.com/ericholscher>`__: Release 5.6.1 (`#7695 <https://github.com/readthedocs/readthedocs.org/pull/7695>`__)
90+
* `@stsewd <https://github.com/stsewd>`__: Tests: mock trigger_build (`#7681 <https://github.com/readthedocs/readthedocs.org/pull/7681>`__)
91+
* `@stsewd <https://github.com/stsewd>`__: Sync versions: use stable version instead of querying all versions (`#7380 <https://github.com/readthedocs/readthedocs.org/pull/7380>`__)
92+
93+
Version 5.6.5
94+
-------------
95+
96+
:Date: November 23, 2020
97+
98+
* `@stsewd <https://github.com/stsewd>`__: Tests: mock trigger_build (`#7681 <https://github.com/readthedocs/readthedocs.org/pull/7681>`__)
99+
* `@stsewd <https://github.com/stsewd>`__: Tests: mock update_docs_task to speed up tests (`#7677 <https://github.com/readthedocs/readthedocs.org/pull/7677>`__)
100+
* `@stsewd <https://github.com/stsewd>`__: Versions: add timestamp fields (`#7676 <https://github.com/readthedocs/readthedocs.org/pull/7676>`__)
101+
* `@stsewd <https://github.com/stsewd>`__: Tests: create an organization when running in .com (`#7673 <https://github.com/readthedocs/readthedocs.org/pull/7673>`__)
102+
* `@davidfischer <https://github.com/davidfischer>`__: Speed up the tag index page (`#7671 <https://github.com/readthedocs/readthedocs.org/pull/7671>`__)
103+
* `@davidfischer <https://github.com/davidfischer>`__: Fix for out of order script loading (`#7670 <https://github.com/readthedocs/readthedocs.org/pull/7670>`__)
104+
* `@davidfischer <https://github.com/davidfischer>`__: Set ad configuration values if using explicit placement (`#7669 <https://github.com/readthedocs/readthedocs.org/pull/7669>`__)
105+
* `@pyup-bot <https://github.com/pyup-bot>`__: pyup: Scheduled weekly dependency update for week 46 (`#7668 <https://github.com/readthedocs/readthedocs.org/pull/7668>`__)
106+
* `@stsewd <https://github.com/stsewd>`__: Tests: mock trigger build to speed up tests (`#7661 <https://github.com/readthedocs/readthedocs.org/pull/7661>`__)
107+
* `@stsewd <https://github.com/stsewd>`__: Remote repository: save and set default_branch (`#7646 <https://github.com/readthedocs/readthedocs.org/pull/7646>`__)
108+
* `@stsewd <https://github.com/stsewd>`__: Search: exclude some fields from source results (`#7640 <https://github.com/readthedocs/readthedocs.org/pull/7640>`__)
109+
* `@stsewd <https://github.com/stsewd>`__: Search: allow to search on different versions of subprojects (`#7634 <https://github.com/readthedocs/readthedocs.org/pull/7634>`__)
110+
* `@stsewd <https://github.com/stsewd>`__: Search: refactor api view (`#7633 <https://github.com/readthedocs/readthedocs.org/pull/7633>`__)
111+
* `@saadmk11 <https://github.com/saadmk11>`__: Add Initial Modeling with Through Model and Data Migration for RemoteRepository Model (`#7536 <https://github.com/readthedocs/readthedocs.org/pull/7536>`__)
112+
* `@stsewd <https://github.com/stsewd>`__: ImportedFile: remove slug 1/2 (`#7228 <https://github.com/readthedocs/readthedocs.org/pull/7228>`__)
113+
* `@humitos <https://github.com/humitos>`__: Changes required for APIv3 in corporate (`#6489 <https://github.com/readthedocs/readthedocs.org/pull/6489>`__)
114+
1115
Version 5.6.4
2116
-------------
3117

docker-compose.override.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ services:
2626
args:
2727
GITHUB_TOKEN: ${GITHUB_TOKEN:-}
2828

29+
cache:
30+
image: redis:4.0.14
31+
2932
nginx:
3033
networks:
3134
readthedocs:

docs/api/v3.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ Project update
357357
"analytics_code": "UA000000",
358358
"analytics_disabled": false,
359359
"single_version": false,
360+
"external_builds_enabled": true,
360361

361362
}
362363

docs/builds.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Our current build limits are:
2323

2424
* 30 minutes build time
2525
* 7GB of memory
26-
* 4 concurrent builds
26+
* Concurrent builds vary based on your pricing plan
2727

2828
If you are having trouble with your documentation builds,
2929
you can reach our support at [email protected].
@@ -80,7 +80,7 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
8080
.. csv-table:: Environment Variables
8181
:header: Environment variable, Description, Example value
8282
:widths: 15, 10, 30
83-
83+
8484
``READTHEDOCS``, Whether the build is running inside RTD, ``True``
8585
``READTHEDOCS_VERSION``, The RTD name of the version which is being built, ``latest``
8686
``READTHEDOCS_PROJECT``, The RTD slug of the project which is being built, ``my-example-project``

docs/config-file/v2.rst

Lines changed: 59 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,56 @@ We recommend the filename ``.readthedocs.yml``.
88
All options are applied to the version containing this file.
99
Below is an example YAML file which shows the most common configuration options:
1010

11-
.. code:: yaml
11+
.. tabs::
1212

13-
# .readthedocs.yml
14-
# Read the Docs configuration file
15-
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
13+
.. tab:: Sphinx
1614

17-
# Required
18-
version: 2
15+
.. code:: yaml
1916
20-
# Build documentation in the docs/ directory with Sphinx
21-
sphinx:
22-
configuration: docs/conf.py
17+
# .readthedocs.yml
18+
# Read the Docs configuration file
19+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
2320
24-
# Build documentation with MkDocs
25-
#mkdocs:
26-
# configuration: mkdocs.yml
21+
# Required
22+
version: 2
2723
28-
# Optionally build your docs in additional formats such as PDF
29-
formats:
30-
- pdf
24+
# Build documentation in the docs/ directory with Sphinx
25+
sphinx:
26+
configuration: docs/conf.py
3127
32-
# Optionally set the version of Python and requirements required to build your docs
33-
python:
34-
version: 3.7
35-
install:
36-
- requirements: docs/requirements.txt
28+
# Optionally build your docs in additional formats such as PDF
29+
formats:
30+
- pdf
3731
32+
# Optionally set the version of Python and requirements required to build your docs
33+
python:
34+
version: 3.7
35+
install:
36+
- requirements: docs/requirements.txt
37+
38+
.. tab:: MkDocs
39+
40+
.. code:: yaml
41+
42+
# .readthedocs.yml
43+
# Read the Docs configuration file
44+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
45+
46+
# Required
47+
version: 2
48+
49+
mkdocs:
50+
configuration: mkdocs.yml
51+
52+
# Optionally build your docs in additional formats such as PDF
53+
formats:
54+
- pdf
55+
56+
# Optionally set the version of Python and requirements required to build your docs
57+
python:
58+
version: 3.7
59+
install:
60+
- requirements: docs/requirements.txt
3861
3962
Supported settings
4063
------------------
@@ -551,6 +574,22 @@ Patterns can include some special characters:
551574
# Ignore all files that end with ref.html
552575
- '*/ref.html'
553576
577+
.. code-block:: yaml
578+
579+
version: 2
580+
581+
search:
582+
ignore:
583+
# Custom files to ignore
584+
- file.html
585+
- api/v1/*
586+
587+
# Defaults
588+
- search.html
589+
- search/index.html
590+
- 404.html
591+
- 404/index.html'
592+
554593
.. note::
555594

556595
Since Read the Docs fallbacks to the original search engine when no results are found,

0 commit comments

Comments
 (0)