Skip to content

Commit

Permalink
Use addons JavaScript file from Docker container (#11785)
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos authored Nov 21, 2024
1 parent dc8c965 commit b9064ab
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion common
10 changes: 2 additions & 8 deletions dockerfiles/nginx/proxito.conf.template
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,11 @@ server {

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

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

# Proxito doc serving
Expand Down
13 changes: 10 additions & 3 deletions docs/dev/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@ Install external dependencies (Docker, Docker Compose, gVisor)
Set up your environment
-----------------------

#. Clone the ``readthedocs.org`` repository:
#. Clone all the required repositories:

.. prompt:: bash

git clone --recurse-submodules https://github.com/readthedocs/readthedocs.org/
git clone --recurse-submodules https://github.com/readthedocs/ext-theme/
git clone --recurse-submodules https://github.com/readthedocs/addons/

#. Install or clone additional repositories:

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

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

.. prompt:: bash

Expand Down Expand Up @@ -89,7 +91,12 @@ Set up your environment

.. prompt:: bash

inv docker.up --init # --init is only needed the first time
inv docker.up --ext-theme --webpack --init

.. warning::

``--init`` is only needed the first time.


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

Expand Down

0 comments on commit b9064ab

Please sign in to comment.