Skip to content

Commit b9064ab

Browse files
authored
Use addons JavaScript file from Docker container (#11785)
Required by readthedocs/common#237
1 parent dc8c965 commit b9064ab

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

dockerfiles/nginx/proxito.conf.template

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,11 @@ server {
2222

2323
# Proxy the "readthedocs-addons.js" to be downloaded from GitHub
2424
location /_/static/javascript/readthedocs-addons.js {
25-
proxy_pass https://raw.githubusercontent.com/readthedocs/addons/$NGINX_ADDONS_GITHUB_TAG/dist/readthedocs-addons.js;
26-
proxy_cache_valid 24h;
27-
proxy_hide_header Content-Type;
28-
add_header Content-Type "text/javascript; charset=utf-8" always;
25+
proxy_pass http://addons:8000/readthedocs-addons.js;
2926
}
3027

3128
location /_/static/javascript/readthedocs-addons.js.map {
32-
proxy_pass https://raw.githubusercontent.com/readthedocs/addons/$NGINX_ADDONS_GITHUB_TAG/dist/readthedocs-addons.js.map;
33-
proxy_cache_valid 24h;
34-
proxy_hide_header Content-Type;
35-
add_header Content-Type "text/javascript; charset=utf-8" always;
29+
proxy_pass http://addons:8000/readthedocs-addons.js.map;
3630
}
3731

3832
# Proxito doc serving

docs/dev/install.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,13 @@ Install external dependencies (Docker, Docker Compose, gVisor)
3434
Set up your environment
3535
-----------------------
3636

37-
#. Clone the ``readthedocs.org`` repository:
37+
#. Clone all the required repositories:
3838

3939
.. prompt:: bash
4040

4141
git clone --recurse-submodules https://github.com/readthedocs/readthedocs.org/
42+
git clone --recurse-submodules https://github.com/readthedocs/ext-theme/
43+
git clone --recurse-submodules https://github.com/readthedocs/addons/
4244

4345
#. Install or clone additional repositories:
4446

@@ -55,7 +57,7 @@ Set up your environment
5557
export GITHUB_USER="..."
5658

5759
In order to make development changes on any of our private repositories,
58-
such as ``readthedocs-ext`` or ``ext-theme``, you will also need to check these repositories out:
60+
such as ``readthedocs-ext``, you will also need to check these repositories out:
5961

6062
.. prompt:: bash
6163

@@ -89,7 +91,12 @@ Set up your environment
8991

9092
.. prompt:: bash
9193

92-
inv docker.up --init # --init is only needed the first time
94+
inv docker.up --ext-theme --webpack --init
95+
96+
.. warning::
97+
98+
``--init`` is only needed the first time.
99+
93100

94101
#. Go to http://devthedocs.org to access your local instance of Read the Docs.
95102

0 commit comments

Comments
 (0)