Skip to content

Commit 515b5e4

Browse files
committed
Merge branch 'main' of github.com:readthedocs/readthedocs.org into humitos/allow-any-filename-pdf-epub
2 parents 38d3649 + 3fec41a commit 515b5e4

File tree

106 files changed

+3536
-3370
lines changed

Some content is hidden

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

106 files changed

+3536
-3370
lines changed

.circleci/config.yml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ jobs:
99
docker:
1010
- image: 'cimg/python:3.10'
1111
environment:
12+
# Don't skip search tests.
1213
TOX_POSARGS: ''
1314
PYTEST_COVERAGE: --cov-report=xml --cov-config .coveragerc --cov=. --cov-append
1415
- image: 'docker.elastic.co/elasticsearch/elasticsearch:8.10.2'
@@ -25,10 +26,33 @@ jobs:
2526
- run: git submodule update --init
2627
- run: sudo apt update
2728
- run: sudo apt install -y rclone
28-
- run: pip install --user 'tox<5'
29+
- run: pip install --user tox
2930
- run: tox -e py310
3031
- codecov/upload
3132

33+
tests-ext-theme:
34+
docker:
35+
- image: 'cimg/python:3.10'
36+
environment:
37+
# Don't skip search tests.
38+
TOX_POSARGS: ''
39+
- image: 'docker.elastic.co/elasticsearch/elasticsearch:8.10.2'
40+
name: search
41+
environment:
42+
discovery.type: single-node
43+
ES_JAVA_OPTS: -Xms750m -Xmx750m
44+
ELASTIC_PASSWORD: password
45+
# Disabled SSL for testing.
46+
xpack.security.transport.ssl.enabled: 'false'
47+
steps:
48+
- checkout
49+
- run: git submodule sync
50+
- run: git submodule update --init
51+
- run: sudo apt update
52+
- run: sudo apt install -y rclone
53+
- run: pip install --user tox
54+
- run: tox -e ext-theme
55+
3256
tests-embedapi:
3357
docker:
3458
- image: 'cimg/python:3.10'
@@ -75,6 +99,7 @@ workflows:
7599
jobs:
76100
- checks
77101
- tests
102+
- tests-ext-theme
78103
- tests-embedapi:
79104
requires:
80105
- checks

CHANGELOG.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,59 @@
1+
Version 11.1.2
2+
--------------
3+
4+
:Date: July 02, 2024
5+
6+
* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#11442 <https://github.com/readthedocs/readthedocs.org/pull/11442>`__)
7+
* `@ericholscher <https://github.com/ericholscher>`__: Run iri_to_uri on header values (`#11439 <https://github.com/readthedocs/readthedocs.org/pull/11439>`__)
8+
* `@ericholscher <https://github.com/ericholscher>`__: Release 11.1.1 (`#11438 <https://github.com/readthedocs/readthedocs.org/pull/11438>`__)
9+
* `@humitos <https://github.com/humitos>`__: Sales: send a Slack message to be able to contact the customer (`#11437 <https://github.com/readthedocs/readthedocs.org/pull/11437>`__)
10+
* `@humitos <https://github.com/humitos>`__: Organization: disable organization on non-active subscription (`#11430 <https://github.com/readthedocs/readthedocs.org/pull/11430>`__)
11+
* `@humitos <https://github.com/humitos>`__: Notification: update copy for "No HTML content found" (`#11410 <https://github.com/readthedocs/readthedocs.org/pull/11410>`__)
12+
* `@agjohnson <https://github.com/agjohnson>`__: API: support rebuilding external version builds with build create endpoint (`#11407 <https://github.com/readthedocs/readthedocs.org/pull/11407>`__)
13+
* `@plaindocs <https://github.com/plaindocs>`__: Minor refactor of Private Python packages page (`#11395 <https://github.com/readthedocs/readthedocs.org/pull/11395>`__)
14+
* `@stsewd <https://github.com/stsewd>`__: Tests: run tests with the ext-theme (`#11383 <https://github.com/readthedocs/readthedocs.org/pull/11383>`__)
15+
* `@ericholscher <https://github.com/ericholscher>`__: Add Pull Request builds page to settings (`#10656 <https://github.com/readthedocs/readthedocs.org/pull/10656>`__)
16+
17+
Version 11.1.1
18+
--------------
19+
20+
:Date: June 25, 2024
21+
22+
* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#11433 <https://github.com/readthedocs/readthedocs.org/pull/11433>`__)
23+
* `@humitos <https://github.com/humitos>`__: Requirements: upgrade `psycopg` to v3 (`#11432 <https://github.com/readthedocs/readthedocs.org/pull/11432>`__)
24+
* `@humitos <https://github.com/humitos>`__: Proxito: allow serving `zh` (deprecated) language code (`#11429 <https://github.com/readthedocs/readthedocs.org/pull/11429>`__)
25+
* `@ericholscher <https://github.com/ericholscher>`__: Be more defensive in redirect code (`#11427 <https://github.com/readthedocs/readthedocs.org/pull/11427>`__)
26+
* `@ericholscher <https://github.com/ericholscher>`__: Link website from docs sidebar (`#11426 <https://github.com/readthedocs/readthedocs.org/pull/11426>`__)
27+
* `@stsewd <https://github.com/stsewd>`__: Use literal `None` in session cookie samesite setting (`#11424 <https://github.com/readthedocs/readthedocs.org/pull/11424>`__)
28+
* `@humitos <https://github.com/humitos>`__: Release 11.1.0 (`#11423 <https://github.com/readthedocs/readthedocs.org/pull/11423>`__)
29+
* `@humitos <https://github.com/humitos>`__: Build: add support for Ubuntu 24.04 LTS (`#11421 <https://github.com/readthedocs/readthedocs.org/pull/11421>`__)
30+
* `@humitos <https://github.com/humitos>`__: Builds: don't call `git clean` anymore (`#11420 <https://github.com/readthedocs/readthedocs.org/pull/11420>`__)
31+
* `@humitos <https://github.com/humitos>`__: Ops: delete triggering a `time-test` build on `build-large` queue (`#11379 <https://github.com/readthedocs/readthedocs.org/pull/11379>`__)
32+
33+
Version 11.1.0
34+
--------------
35+
36+
:Date: June 18, 2024
37+
38+
* `@olgaigig <https://github.com/olgaigig>`__: Update docs.rst (`#11422 <https://github.com/readthedocs/readthedocs.org/pull/11422>`__)
39+
* `@humitos <https://github.com/humitos>`__: Build: add support for Ubuntu 24.04 LTS (`#11421 <https://github.com/readthedocs/readthedocs.org/pull/11421>`__)
40+
* `@humitos <https://github.com/humitos>`__: Builds: don't call `git clean` anymore (`#11420 <https://github.com/readthedocs/readthedocs.org/pull/11420>`__)
41+
* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#11415 <https://github.com/readthedocs/readthedocs.org/pull/11415>`__)
42+
* `@humitos <https://github.com/humitos>`__: New dashboard: use `app.` instead of `beta.` (`#11412 <https://github.com/readthedocs/readthedocs.org/pull/11412>`__)
43+
* `@humitos <https://github.com/humitos>`__: Build: remove "beta" from `build.commands` (`#11411 <https://github.com/readthedocs/readthedocs.org/pull/11411>`__)
44+
* `@humitos <https://github.com/humitos>`__: Docs: update "Example projects" a little (`#11404 <https://github.com/readthedocs/readthedocs.org/pull/11404>`__)
45+
* `@stsewd <https://github.com/stsewd>`__: Oauth: Fix GitLab access token URL (`#11402 <https://github.com/readthedocs/readthedocs.org/pull/11402>`__)
46+
* `@humitos <https://github.com/humitos>`__: Build: update `asdf` and its plugins so we can build latest versions (`#11401 <https://github.com/readthedocs/readthedocs.org/pull/11401>`__)
47+
* `@humitos <https://github.com/humitos>`__: Settings: revert `USE_PROMOS` setting (`#11400 <https://github.com/readthedocs/readthedocs.org/pull/11400>`__)
48+
* `@ericholscher <https://github.com/ericholscher>`__: Add Unknown for missing VCS class (`#11398 <https://github.com/readthedocs/readthedocs.org/pull/11398>`__)
49+
* `@ericholscher <https://github.com/ericholscher>`__: Release 11.0.0 (`#11397 <https://github.com/readthedocs/readthedocs.org/pull/11397>`__)
50+
* `@rffontenelle <https://github.com/rffontenelle>`__: GitHub with uppercase H in onboard_import.html (`#11396 <https://github.com/readthedocs/readthedocs.org/pull/11396>`__)
51+
* `@humitos <https://github.com/humitos>`__: Templates: pass `ADMIN_URL` into context (`#11394 <https://github.com/readthedocs/readthedocs.org/pull/11394>`__)
52+
* `@rffontenelle <https://github.com/rffontenelle>`__: Uppercase G for Gold membership in subscription_detail.html (`#11388 <https://github.com/readthedocs/readthedocs.org/pull/11388>`__)
53+
* `@humitos <https://github.com/humitos>`__: Build: update all `build.tools` and add latest versions (`#11386 <https://github.com/readthedocs/readthedocs.org/pull/11386>`__)
54+
* `@humitos <https://github.com/humitos>`__: Translations: disable `zh` code (`#11385 <https://github.com/readthedocs/readthedocs.org/pull/11385>`__)
55+
* `@humitos <https://github.com/humitos>`__: VCS: remove code for old VCS support (`#11377 <https://github.com/readthedocs/readthedocs.org/pull/11377>`__)
56+
157
Version 11.0.0
258
--------------
359

common

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676

7777
master_doc = "index"
7878
copyright = "Read the Docs, Inc & contributors"
79-
version = "11.0.0"
79+
version = "11.1.2"
8080
release = version
8181
exclude_patterns = ["_build", "shared", "_includes"]
8282
default_role = "obj"

docs/dev/docs.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,34 @@ the documentation for Read the Docs is built using Sphinx and hosted on Read the
66
The docs are kept in the ``docs/`` directory at the top of the source tree,
77
and are divided into developer and user-facing documentation.
88

9-
Contributing through the Github UI
9+
Contributing through the GitHub UI
1010
----------------------------------
1111

1212
If you're making small changes to the documentation,
13-
you can verify those changes through the documentation generated when you open a PR and can be accessed using the Github UI.
13+
you can verify those changes through the documentation generated when you open a PR and can be accessed using the GitHub UI.
1414

15-
#. click the checkmark next to your commit and it will expand to have multiple options
15+
#. Click the checkmark next to your commit and it will expand to have multiple options.
1616

17-
#. click the "details" link next to the "docs/readthedocs.org:docs" item
17+
#. Click the "details" link next to the "docs/readthedocs.org:docs" item:
1818

1919
.. image:: /img/details_link.png
2020

21-
#. navigate to the section of the documentation you worked on to verify your changes
21+
#. Navigate to the section of the documentation you worked on to verify your changes.
2222

2323
Contributing from your local machine
2424
------------------------------------
2525

2626
If you're making large changes to the documentation,
2727
you may want to verify those changes locally before pushing upstream.
2828

29-
#. clone the `readthedocs.org` repository:
29+
#. Clone the `readthedocs.org` repository:
3030

3131
.. code-block:: console
3232
3333
$ git clone --recurse-submodules https://github.com/readthedocs/readthedocs.org/
3434
35-
#. create a virtual environment with Python 3.8
36-
(preferably the latest release, 3.8.12 at the time of writing),
35+
#. Create a virtual environment with Python 3.8
36+
(preferably the latest release),
3737
activate it, and upgrade pip:
3838

3939
.. code-block:: console
@@ -43,14 +43,14 @@ you may want to verify those changes locally before pushing upstream.
4343
$ source .venv/bin/activate
4444
(.venv) $ python -m pip install -U pip
4545
46-
#. install documentation requirements
46+
#. Install the documentation requirements:
4747

4848
.. code-block:: console
4949
5050
(.venv) $ pip install -r requirements/testing.txt
5151
(.venv) $ pip install -r requirements/docs.txt
5252
53-
#. build the documents
53+
#. Build the documents:
5454

5555
To build the user-facing documentation:
5656

@@ -66,4 +66,4 @@ you may want to verify those changes locally before pushing upstream.
6666
(.venv) $ cd docs
6767
(.venv) $ RTD_DOCSET=dev make livehtml
6868
69-
#. the documents will be available at http://127.0.0.1:4444/ and will rebuild each time you edit and save a file.
69+
#. Check the changes locally at http://127.0.0.1:4444/ (rebuilds each time you edit and save a file).

docs/dev/style-guide.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,21 @@ Content
4949
* ``:guilabel:`<your username>` dropdown``
5050
* Make sure that **all bullet list items end with a period**, and don't mix periods with no periods.
5151

52+
Linting
53+
~~~~~~~
54+
55+
ReStructuredText for both the RTD user documentation and this developer documentation is linted with `pre-commit` for broken links,
56+
whitespace consistency, and other minor issues.
57+
58+
You can fix many linting issues automatically by installing and running `pre-commit` locally.
59+
To run it on content you have have already committed, use the ``--from-ref`` and ``--to-ref`` `flags <https://pre-commit.com/#pre-commit-run>`__.
60+
61+
.. code-block:: bash
62+
63+
pre-commit run --from-ref <OLDER_COMMIT> --to-ref <RECENT_COMMIT>
64+
65+
Or use ``pre-commit run --all-files`` to lint all files.
66+
5267
Word list
5368
---------
5469

docs/user/config-file/v2.rst

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,9 @@ Configuration of the Python environment to be used.
130130
python.install
131131
``````````````
132132

133+
Read the Docs uses :doc:`pip <pip:index>` by default to install your Python packages, however if you are using a :ref:`Conda <config-file/v2:conda>` environment to manage your build, you'll need to use the Conda ``environment`` file instead.
134+
If you have a commercial plan you can also install :doc:`private dependencies </guides/private-python-packages>`.
135+
133136
List of installation methods of packages and requirements.
134137
You can have several of the following methods.
135138

@@ -158,16 +161,11 @@ Example:
158161
- requirements: docs/requirements.txt
159162
- requirements: requirements.txt
160163
161-
.. warning::
162-
163-
If you are using a :ref:`Conda <config-file/v2:conda>` environment to
164-
manage the build, this setting will not have any effect. Instead
165-
add the extra requirements to the ``environment`` file of Conda.
166-
167164
Packages
168165
''''''''
169166

170-
Install the project using ``pip install`` (recommended) or ``python setup.py install`` (deprecated).
167+
Install the project using ``pip install``.
168+
The use of ``python setup.py install`` is deprecated.
171169

172170
The path to the package, relative to the root of the project.
173171

@@ -186,15 +184,11 @@ The installation method.
186184
.. _Extra Requirements: https://setuptools.readthedocs.io/en/latest/userguide/dependency_management.html#optional-dependencies
187185
.. _package dependencies: https://setuptools.readthedocs.io/en/latest/userguide/dependency_management.html#declaring-required-dependency
188186

189-
.. warning::
190-
191-
You need to install your project with ``pip`` to use ``extra_requirements``.
192-
193187
:Key: ``extra_requirements``
194188
:Type: ``list``
195189
:Default: ``[]``
196190

197-
Example:
191+
For example, to run ``pip install .[docs]``:
198192

199193
.. code-block:: yaml
200194
@@ -207,12 +201,6 @@ Example:
207201
extra_requirements:
208202
- docs
209203
210-
With the previous settings, Read the Docs will execute the next commands:
211-
212-
.. prompt:: bash $
213-
214-
pip install .[docs]
215-
216204
conda
217205
~~~~~
218206

@@ -274,7 +262,7 @@ Image names refer to the operating system Read the Docs uses to build them.
274262
Arbitrary Docker images are not supported.
275263

276264
:Type: ``string``
277-
:Options: ``ubuntu-20.04``, ``ubuntu-22.04``, ``ubuntu-lts-latest``
265+
:Options: ``ubuntu-20.04``, ``ubuntu-22.04``, ``ubuntu-24.04``, ``ubuntu-lts-latest``
278266
:Required: ``true``
279267

280268
.. note::

0 commit comments

Comments
 (0)