Skip to content

Commit 1fed4f9

Browse files
benjaomingbenjaoming
committed
Merge branch 'main' of github.com:readthedocs/readthedocs.org into diataxis/main
2 parents cc1c767 + 15ade5f commit 1fed4f9

File tree

56 files changed

+7852
-5998
lines changed

Some content is hidden

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

56 files changed

+7852
-5998
lines changed

‎.env

+4
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
COMPOSE_PROJECT_NAME=community
2+
# Current setup assumes Docker Compose v1.
3+
# In v2, underscores are replaced by dashes in image and network names,
4+
# which breaks the assumption.
5+
COMPOSE_COMPATIBILITY=true

‎CHANGELOG.rst

+28
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
Version 9.0.0
2+
-------------
3+
4+
This version upgrades our Search API experience to a v3.
5+
6+
:Date: November 28, 2022
7+
8+
* `@Jean-Maupas <https://github.com/Jean-Maupas>`__: A few text updates (`#9761 <https://github.com/readthedocs/readthedocs.org/pull/9761>`__)
9+
* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#9760 <https://github.com/readthedocs/readthedocs.org/pull/9760>`__)
10+
* `@benjaoming <https://github.com/benjaoming>`__: Docs: 4 diátaxis categories at the top of the navigation sidebar (Diátaxis iteration 0) (`#9758 <https://github.com/readthedocs/readthedocs.org/pull/9758>`__)
11+
* `@ericholscher <https://github.com/ericholscher>`__: Be more explicit where go to in VCS intstructions (`#9757 <https://github.com/readthedocs/readthedocs.org/pull/9757>`__)
12+
* `@benjaoming <https://github.com/benjaoming>`__: Docs: Adding a pattern for reusing "Only on Read the Docs for Business" admonition (Diátaxis refactor) (`#9754 <https://github.com/readthedocs/readthedocs.org/pull/9754>`__)
13+
* `@stsewd <https://github.com/stsewd>`__: Subscriptions: attach stripe subscription to organizations (`#9751 <https://github.com/readthedocs/readthedocs.org/pull/9751>`__)
14+
* `@stsewd <https://github.com/stsewd>`__: Search: fix parsing of parameters inside sphinx domains (`#9750 <https://github.com/readthedocs/readthedocs.org/pull/9750>`__)
15+
* `@eltociear <https://github.com/eltociear>`__: Fix typo in private.py (`#9744 <https://github.com/readthedocs/readthedocs.org/pull/9744>`__)
16+
* `@browniebroke <https://github.com/browniebroke>`__: Docs: update instructions to install deps with Poetry (`#9743 <https://github.com/readthedocs/readthedocs.org/pull/9743>`__)
17+
* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#9742 <https://github.com/readthedocs/readthedocs.org/pull/9742>`__)
18+
* `@humitos <https://github.com/humitos>`__: Telemetry: include all the PyPI packages (`#9737 <https://github.com/readthedocs/readthedocs.org/pull/9737>`__)
19+
* `@humitos <https://github.com/humitos>`__: Docs: cancel PR builds if there is no documentation changes (`#9734 <https://github.com/readthedocs/readthedocs.org/pull/9734>`__)
20+
* `@humitos <https://github.com/humitos>`__: Docs: add an example for custom domain input (`#9733 <https://github.com/readthedocs/readthedocs.org/pull/9733>`__)
21+
* `@humitos <https://github.com/humitos>`__: Release 8.9.0 (`#9732 <https://github.com/readthedocs/readthedocs.org/pull/9732>`__)
22+
* `@ericholscher <https://github.com/ericholscher>`__: Add an initial policy for delisting unmaintained projects (`#9731 <https://github.com/readthedocs/readthedocs.org/pull/9731>`__)
23+
* `@saadmk11 <https://github.com/saadmk11>`__: Admin: Make `VersionInline` Read-only (`#9697 <https://github.com/readthedocs/readthedocs.org/pull/9697>`__)
24+
* `@stsewd <https://github.com/stsewd>`__: Search: API V3 (`#9625 <https://github.com/readthedocs/readthedocs.org/pull/9625>`__)
25+
* `@stsewd <https://github.com/stsewd>`__: Audit log: log invitations (`#9607 <https://github.com/readthedocs/readthedocs.org/pull/9607>`__)
26+
* `@stsewd <https://github.com/stsewd>`__: Design doc: new search API (`#9533 <https://github.com/readthedocs/readthedocs.org/pull/9533>`__)
27+
* `@humitos <https://github.com/humitos>`__: Docs: `poetry` example on `build.jobs` section (`#9445 <https://github.com/readthedocs/readthedocs.org/pull/9445>`__)
28+
129
Version 8.9.0
230
-------------
331

‎docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969

7070
master_doc = "index"
7171
copyright = "Read the Docs, Inc & contributors"
72-
version = "8.9.0"
72+
version = "9.0.0"
7373
release = version
7474
exclude_patterns = ["_build", "shared"]
7575
default_role = "obj"

‎docs/dev/install.rst

+14-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Development Installation
44
.. meta::
55
:description lang=en: Install a local development instance of Read the Docs with our step by step guide.
66

7-
These are development setup and :ref:`standards <install:Core team standards>` that are followed to by the core development team. If you are a contributor to Read the Docs,
8-
it might a be a good idea to follow these guidelines as well.
7+
These are development setup and :ref:`standards <install:Core team standards>` that are followed to by the core development team.
8+
If you are a contributor to Read the Docs, it might a be a good idea to follow these guidelines as well.
99

1010
Requirements
1111
------------
@@ -224,6 +224,17 @@ For others, the webhook will simply fail to connect when there are new commits t
224224
Troubleshooting
225225
---------------
226226

227+
.. warning::
228+
229+
The environment is developed and mainly tested on Docker Compose v1.x.
230+
If you are running Docker Compose 2.x, please make sure you have ``COMPOSE_COMPATIBILITY=true`` set.
231+
This is automatically loaded via the ``.env`` file.
232+
If you want to ensure that the file is loaded, run:
233+
234+
.. code-block:: console
235+
236+
source .env
237+
227238
Builds fail with a generic error
228239
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
229240

@@ -267,6 +278,7 @@ you have to follow these steps:
267278

268279
Once this is done, you should be able to trigger a new build on that project and it should succeed.
269280

281+
270282
Core team standards
271283
-------------------
272284

‎docs/dev/search-integration.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Server Side Search Integration
22
==============================
33

4-
Read the Docs provides :doc:`server side search (SSS) <rtd:server-side-search>`
4+
Read the Docs provides :doc:`server side search (SSS) <rtd:server-side-search/index>`
55
in replace of the default search engine of your site.
66
To accomplish this, Read the Docs parses the content directly from your HTML pages [*]_.
77

‎docs/user/index.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ Read the Docs: Documentation Simplified
44
.. meta::
55
:description lang=en: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.
66

7+
.. Adds a hidden link for the purpose of validating Read the Docs' Mastodon profile
8+
.. raw:: html
9+
10+
<a style="display: none;" rel="me" href="https://fosstodon.org/@readthedocs">Mastodon</a>
11+
712
`Read the Docs`_ simplifies software documentation
813
by building, versioning, and hosting of your docs, automatically.
914
This enables many "docs like code" workflows,
@@ -290,7 +295,7 @@ of Read the Docs and the larger software documentation ecosystem.
290295

291296
* **Getting involved with Read the Docs**:
292297
:doc:`/glossary` |
293-
:doc:`/gsoc`|
298+
:doc:`/gsoc` |
294299
:doc:`Developer Documentation <rtd-dev:index>`
295300

296301

‎docs/user/tutorial/index.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ Read the Docs tutorial
22
======================
33

44
In this tutorial you will create a documentation project on Read the Docs
5-
by importing an Sphinx project from a GitHub repository,
5+
by importing a Sphinx project from a GitHub repository,
66
tailor its configuration, and explore several useful features of the platform.
77

88
The tutorial is aimed at people interested in learning
99
how to use Read the Docs to host their documentation projects.
1010
You will fork a fictional software library
1111
similar to the one developed in the :doc:`official Sphinx tutorial <sphinx:tutorial/index>`.
12-
No prior experience with Sphinx is required,
12+
No prior experience with Sphinx is required
1313
and you can follow this tutorial without having done the Sphinx one.
1414

15-
The only things you will need to follow are
15+
The only things you will need are
1616
a web browser, an Internet connection, and a GitHub account
1717
(you can `register for a free account <https://github.com/signup>`_ if you don't have one).
1818
You will use Read the Docs Community, which means that the project will be public.
@@ -97,8 +97,8 @@ By now, you should have two email notifications:
9797
* Another one from Read the Docs, prompting you to "verify your email
9898
address". Click on the link to finalize the process.
9999

100-
Finally, you created your account on Read the Docs
101-
and are ready to import your first project.
100+
Once done, your Read the Docs account is created
101+
and ready to import your first project.
102102

103103
Welcome!
104104

@@ -353,8 +353,8 @@ Making warnings more visible
353353
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
354354

355355
If you navigate to your HTML documentation,
356-
you will notice that the index page looks correct,
357-
but actually the API section is empty.
356+
you will notice that the index page looks correct
357+
but the API section is empty.
358358
This is a very common issue with Sphinx,
359359
and the reason is stated in the build logs.
360360
On the build page you opened before,

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "readthedocs",
3-
"version": "8.9.0",
3+
"version": "9.0.0",
44
"description": "Read the Docs build dependencies",
55
"author": "Read the Docs, Inc <[email protected]>",
66
"scripts": {

‎readthedocs/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
"""Read the Docs."""
22

33

4-
__version__ = "8.9.0"
4+
__version__ = "9.0.0"

‎readthedocs/core/finders.py

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import os
2+
3+
from debug_toolbar.apps import DebugToolbarConfig
4+
from django.contrib.staticfiles.finders import AppDirectoriesFinder
5+
6+
7+
class DebugToolbarFinder(AppDirectoriesFinder):
8+
9+
"""
10+
Finder to copy the static files for `debug_toolbar` even if it's not installed.
11+
12+
We want to do this because we run `collectstatic` from `web` instance
13+
which does not have `debug_toolbar` installed.
14+
Then, when running the `admin` instance from `web-extra` with `debug_toolbar` installed,
15+
if fails because it does not find the static files.
16+
17+
By forcing collecting these static files even when `debug_toolbar` is not installed,
18+
we avoid this issue when running the `admin` instance.
19+
"""
20+
21+
def __init__(self, *args, app_names=None, **kwargs):
22+
app_config = DebugToolbarConfig.create("debug_toolbar")
23+
self.apps = [app_config.name]
24+
self.storages = {
25+
app_config.name: self.storage_class(
26+
os.path.join(
27+
app_config.path,
28+
self.source_dir,
29+
)
30+
)
31+
}

0 commit comments

Comments
 (0)