Skip to content

Commit 76604af

Browse files
committed
Merge branch 'master' of github.com:readthedocs/readthedocs.org into remote-repository-normalization
2 parents d7a0445 + 9d9441d commit 76604af

Some content is hidden

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

50 files changed

+1526
-220
lines changed

.readthedocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ search:
2121
# Useful content, but not something we want most users finding
2222
custom_installs/*: -6
2323
changelog.html: -6
24+
development/install.html: -6

CHANGELOG.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
Version 5.11.0
2+
--------------
3+
4+
:Date: March 02, 2021
5+
6+
* `@saadmk11 <https://github.com/saadmk11>`__: Add management command to Load Project and RemoteRepository Relationship from JSON file (`#7966 <https://github.com/readthedocs/readthedocs.org/pull/7966>`__)
7+
* `@humitos <https://github.com/humitos>`__: Lower rank of development/install.html (`#7960 <https://github.com/readthedocs/readthedocs.org/pull/7960>`__)
8+
* `@saadmk11 <https://github.com/saadmk11>`__: Add Management Command to Dump Project and RemoteRepository Relationship in JSON format (`#7957 <https://github.com/readthedocs/readthedocs.org/pull/7957>`__)
9+
* `@davidfischer <https://github.com/davidfischer>`__: Enable the cached template loader (`#7953 <https://github.com/readthedocs/readthedocs.org/pull/7953>`__)
10+
* `@stsewd <https://github.com/stsewd>`__: Update common to master (`#7951 <https://github.com/readthedocs/readthedocs.org/pull/7951>`__)
11+
* `@stsewd <https://github.com/stsewd>`__: Embed: refactor tests (`#7947 <https://github.com/readthedocs/readthedocs.org/pull/7947>`__)
12+
* `@stsewd <https://github.com/stsewd>`__: Downgrade jedi (`#7946 <https://github.com/readthedocs/readthedocs.org/pull/7946>`__)
13+
* `@FatGrizzly <https://github.com/FatGrizzly>`__: Added warnings for previous gitbook users (`#7945 <https://github.com/readthedocs/readthedocs.org/pull/7945>`__)
14+
* `@stsewd <https://github.com/stsewd>`__: Move embed app (`#7943 <https://github.com/readthedocs/readthedocs.org/pull/7943>`__)
15+
* `@ericholscher <https://github.com/ericholscher>`__: Change our sponsored hosting from Azure -> AWS. (`#7940 <https://github.com/readthedocs/readthedocs.org/pull/7940>`__)
16+
* `@Pradhvan <https://github.com/Pradhvan>`__: Docs: Adds Myst to the getting started with sphinx (`#7938 <https://github.com/readthedocs/readthedocs.org/pull/7938>`__)
17+
* `@ericholscher <https://github.com/ericholscher>`__: Add a support form to the website (`#7929 <https://github.com/readthedocs/readthedocs.org/pull/7929>`__)
18+
* `@stsewd <https://github.com/stsewd>`__: Drop six (`#7890 <https://github.com/readthedocs/readthedocs.org/pull/7890>`__)
19+
* `@fabianmp <https://github.com/fabianmp>`__: Allow to use a different url for intersphinx object file download (`#7807 <https://github.com/readthedocs/readthedocs.org/pull/7807>`__)
20+
121
Version 5.10.0
222
--------------
323

docs/custom_domains.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ You will need to update your CAA records to allow us to issue the certificate.
127127
.. _Cloudflare CAA FAQ: https://support.cloudflare.com/hc/en-us/articles/115000310832-Certification-Authority-Authorization-CAA-FAQ
128128
.. _Amazon CAA guide: https://docs.aws.amazon.com/acm/latest/userguide/setup-caa.html
129129

130+
.. note::
131+
132+
If your custom domain was previously used in GitBook, contact GitBook support (via live chat in their website)
133+
to remove the domain name from their DNS Zone in order for your domain name to work with Read the Docs,
134+
else it will always redirect to GitBook.
130135

131136
Proxy SSL
132137
---------

docs/development/architecture.rst

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,18 @@ Diagram
88
::
99

1010
+-----------+
11-
| Azure |
1211
+-----| Load Bal |------+
1312
| +-----------+ |
1413
| |
15-
+---------+ +---------+
16-
+-------------+ | | | | +--------------+
17-
| |-----| Nginx | | Nginx |----| |
18-
| File | +---------+ +---------+ | File |
19-
| System | | | | System |
20-
+-------------+ +---------+ +--------+ +---------+ +--------------+
21-
| | |Gunicorn | | | |Gunicorn | | |
22-
| +---------|(Django) |--|Postgres|--|(Django) |--------+ |
23-
| +---------+ +--------+ +---------+ |
14+
+---------+ +---------+
15+
+-------------+ | | | | +--------------+
16+
| |-----| Nginx | | Nginx |----| |
17+
| File | +---------+ +---------+ | File |
18+
| System | | | | System |
19+
+-------------+ +---------+ +--------+ +---------+ +--------------+
20+
| | |Gunicorn | | | |Gunicorn | | |
21+
| +---------|(Django) |--|Postgres|--|(Django) |--------+ |
22+
| +---------+ +--------+ +---------+ |
2423
| | | |
2524
| | | |
2625
| -----------API------------ |
@@ -29,12 +28,12 @@ Diagram
2928
| +------------------+ |
3029
| | | |
3130
+---------------------| Build Server |-------------------+
32-
| |
33-
+------------------+
34-
35-
36-
37-
31+
| |
32+
+------------------+
33+
34+
35+
36+
3837

3938

4039

docs/development/settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Default: :djangosetting:`PRODUCTION_DOMAIN`
3838
This is the domain that gets linked to throughout the site when used in production.
3939
It depends on `USE_SUBDOMAIN`, otherwise it isn't used.
4040

41+
RTD_INTERSPHINX_URL
42+
-------------------
43+
44+
Default: :djangosetting:`RTD_INTERSPHINX_URL`
45+
46+
This is the domain that is used to fetch the intersphinx inventory file.
47+
If not set explicitly this is the ``PRODUCTION_DOMAIN``.
48+
4149
MULTIPLE_APP_SERVERS
4250
--------------------
4351

docs/development/standards.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Celery is isolated from database
5151
Use NGINX as web server
5252
All the site is served via NGINX with the ability to change some configuration locally.
5353

54-
Azurite as Django storage backend
55-
All static and media files are served using Azurite --an emulator of Azure Blob Storage,
54+
MinIO as Django storage backend
55+
All static and media files are served using Minio --an emulator of S3,
5656
which is the one used in production.
5757

5858
Serve documentation via El Proxito

docs/intro/getting-started-with-sphinx.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,24 +91,26 @@ by :doc:`importing your docs </intro/import-guide>`.
9191
Using Markdown with Sphinx
9292
--------------------------
9393

94-
You can use Markdown and reStructuredText in the same Sphinx project.
94+
You can use `Markdown using MyST`_ and reStructuredText in the same Sphinx project.
9595
We support this natively on Read the Docs, and you can do it locally:
9696

9797
.. prompt:: bash $
9898

99-
pip install recommonmark
99+
pip install myst-parser
100100

101101
Then in your ``conf.py``:
102102

103103
.. code-block:: python
104104
105-
extensions = ['recommonmark']
105+
extensions = ['myst-parser']
106106
107-
.. warning:: Markdown doesn't support a lot of the features of Sphinx,
108-
like inline markup and directives. However, it works for
109-
basic prose content. reStructuredText is the preferred
110-
format for technical documentation, please read `this blog post`_
111-
for motivation.
107+
.. warning::
108+
109+
Markdown does works for basic prose content.
110+
But reStructuredText is the preferred format for technical documentation,
111+
please read `this blog post`_ for motivation.
112+
113+
.. _Markdown using MyST: https://myst-parser.readthedocs.io/en/latest/using/intro.html
112114

113115
.. _this blog post: https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/
114116

docs/sponsors.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ supporting us.
99
Current sponsors
1010
----------------
1111

12-
* `Microsoft Azure`_ - They cover all of our hosting expenses every month. This is a pretty large sum of money, averaging around $3,000/mo, and we are really grateful to have them as a sponsor.
12+
* `AWS`_ - They cover all of our hosting expenses every month. This is a pretty large sum of money, averaging around $5,000/mo.
1313
* `Cloudflare`_ - Cloudflare is providing us with an enterprise plan of their SSL for SaaS Providers product that enables us to provide SSL certificates for custom domains.
14-
* You? (Email us at rev@readthedocs.org for more info)
14+
* You? (Email us at hello@readthedocs.org for more info)
1515

1616
Past sponsors
1717
-------------
1818

19+
* `Microsoft Azure`_
1920
* `Python Software Foundation`_
2021
* `Revsys`_
2122
* `Mozilla Web Dev`_
@@ -34,6 +35,7 @@ Past sponsors
3435
.. _Twilio: https://www.twilio.com/
3536
.. _Cloudflare: https://www.cloudflare.com/
3637
.. _Microsoft Azure: https://azure.microsoft.com/
38+
.. _AWS: https://aws.amazon.com/
3739

3840

3941
Sponsorship Information

docs/support.rst

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Support
2-
=======
1+
Site Support
2+
============
33

44
Usage Questions
55
---------------
@@ -14,34 +14,34 @@ Good questions for Stack Overflow would be:
1414
* "How do I structure translations inside of my project for easiest contribution from users?"
1515
* "How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?"
1616

17+
You might also find the answers you are looking for in our :doc:`documentation guides </guides/index>`.
18+
These provide step-by-step solutions to common user requirements.
19+
1720
User Support
1821
------------
1922

2023
If you need a specific request for your project or account,
2124
like more resources, change of the project's slug or username.
22-
Send an email to [email protected].
23-
We will get to you as soon as possible.
2425

25-
Bug Reports
26-
-----------
26+
.. tabs::
27+
28+
.. tab:: |org_brand|
2729

28-
You can file bug reports on our `GitHub issue tracker`_,
29-
and they will be addressed as soon as possible.
30-
Please only file issues with our actual codebase there,
31-
not user support questions
30+
Please fill out the form at https://readthedocs.org/support/,
31+
and we will reply as soon as possible.
3232

33-
Reporting Issues
34-
~~~~~~~~~~~~~~~~
33+
.. tab:: |com_brand|
3534

36-
When reporting a bug,
37-
please include as much information as possible that will help us solve this issue.
38-
This includes:
35+
Please fill out the form at https://readthedocs.com/support/,
36+
and we will reply within 1 business day for most plans.
37+
38+
Bug Reports
39+
-----------
3940

40-
* Project name
41-
* URL
42-
* Action taken
43-
* Expected result
44-
* Actual result
41+
If you have an issue with the actual functioning of the site,
42+
you can file bug reports on our `GitHub issue tracker`_.
43+
You can also :doc:`contribute </contribute>` to Read the Docs,
44+
as the code is open source.
4545

4646
Priority Support
4747
----------------
@@ -50,6 +50,4 @@ We offer priority support with :doc:`Read the Docs for Business </commercial/ind
5050
and we have a dedicated team that responds to support requests during business hours.
5151

5252
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/read-the-docs
53-
.. _Github Issue Tracker: https://github.com/readthedocs/readthedocs.org/issues
54-
.. _Gold: https://readthedocs.org/accounts/gold/
55-
.. _Ethical Ads: https://docs.readthedocs.io/en/latest/ethical-advertising.html
53+
.. _Github issue tracker: https://github.com/readthedocs/readthedocs.org/issues

media/images/sponsors/aws.png

1.73 KB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "readthedocs",
3-
"version": "5.10.0",
3+
"version": "5.11.0",
44
"description": "Read the Docs build dependencies",
55
"author": "Anthony Johnson <[email protected]>",
66
"scripts": {

readthedocs/builds/static/builds/js/detail.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

readthedocs/core/static/core/js/readthedocs-doc-embed.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

readthedocs/core/static/core/js/site.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

readthedocs/core/templatetags/core_tags.py

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -53,44 +53,6 @@ def make_document_url(project, version=None, page='', path=''):
5353
return resolve(project=project, version_slug=version, filename=filename)
5454

5555

56-
@register.filter(is_safe=True)
57-
def restructuredtext(value, short=False):
58-
try:
59-
from docutils.core import publish_parts
60-
from docutils import ApplicationError
61-
except ImportError:
62-
if settings.DEBUG:
63-
raise template.TemplateSyntaxError(
64-
"Error in 'restructuredtext' filter: "
65-
"The Python docutils library isn't installed.",
66-
)
67-
return force_text(value)
68-
else:
69-
docutils_settings = {
70-
'raw_enabled': False,
71-
'file_insertion_enabled': False,
72-
}
73-
docutils_settings.update(
74-
settings.RESTRUCTUREDTEXT_FILTER_SETTINGS,
75-
)
76-
try:
77-
parts = publish_parts(
78-
source=force_bytes(value),
79-
writer_name='html4css1',
80-
settings_overrides=docutils_settings,
81-
)
82-
except ApplicationError:
83-
return force_text(value)
84-
85-
out = force_text(parts['fragment'])
86-
try:
87-
if short:
88-
out = out.split('\n')[0]
89-
except IndexError:
90-
pass
91-
return mark_safe(out)
92-
93-
9456
@register.filter
9557
def get_project(slug):
9658
try:

readthedocs/core/views/__init__.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@ def get_context_data(self, **kwargs):
3434
return context
3535

3636

37+
class SupportView(TemplateView):
38+
39+
template_name = 'support/index.html'
40+
41+
def get_context_data(self, **kwargs):
42+
"""Pass along endpoint for support form."""
43+
context = super().get_context_data(**kwargs)
44+
context['SUPPORT_FORM_ENDPOINT'] = settings.SUPPORT_FORM_ENDPOINT
45+
return context
46+
47+
3748
def wipe_version(request, project_slug, version_slug):
3849
version = get_object_or_404(
3950
Version.internal.all(),

0 commit comments

Comments
 (0)