Skip to content

Commit 15aa633

Browse files
PerseudonymousPerseudonymous
committed
Merge branch 'master' of github.com:rtfd/readthedocs.org
2 parents 002bd74 + 5067f5c commit 15aa633

Some content is hidden

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

43 files changed

+970
-304
lines changed

‎.github/mergeable.yml

+22-24
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
11
# ProBot Mergeable Bot
22
# https://github.com/jusx/mergeable
33

4+
version: 2
45
mergeable:
5-
pull_requests:
6-
approvals:
7-
# Minimum of approvals needed.
8-
min: 1
9-
message: 'The PR must have a minimum of 1 approvals.'
10-
11-
description:
12-
no_empty:
13-
# Do not allow empty descriptions on PR.
14-
enabled: false
15-
message: 'Description can not be empty.'
16-
17-
must_exclude:
18-
# Do not allow 'DO NOT MERGE' phrase on PR's description.
19-
regex: 'DO NOT MERGE'
20-
message: 'Description says that the PR should not be merged yet.'
21-
22-
# Do not allow 'WIP' on PR's title.
23-
title: 'WIP'
24-
25-
label:
26-
# Do not allow PR with label 'PR: work in progress'
27-
must_exclude: 'PR: work in progress'
28-
message: 'This PR is work in progress.'
6+
- when: pull_request.*
7+
validate:
8+
- do: title
9+
# Do not merge when it is marked work in progress (WIP)
10+
must_exclude:
11+
regex: ^\[WIP\]
12+
message: This is work in progress. Do not merge yet.
13+
- do: description
14+
must_exclude:
15+
# Do not allow 'DO NOT MERGE' phrase on PR's description.
16+
regex: 'DO NOT MERGE'
17+
message: 'Description says that the PR should not be merged yet.'
18+
no_empty:
19+
# Do not allow empty descriptions on PR.
20+
enabled: true
21+
message: 'Description can not be empty.'
22+
- do: label
23+
# Do not allow PR with label 'PR: work in progress' or 'Status: blocked'
24+
must_exclude:
25+
regex: 'PR: work in progress|Status: blocked'
26+
message: 'This PR is work in progress or it is still blocked.'

‎docs/.rstcheck.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[rstcheck]
22
ignore_directives=automodule,http:get,tabs,tab,prompt
3-
ignore_roles=djangosetting,setting
3+
ignore_roles=djangosetting,setting,featureflags,buildpyversions
44
ignore_messages=(Duplicate implicit target name: ".*")|(Hyperlink target ".*" is not referenced)

‎docs/badges.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ since it will stay up to date with your Read the Docs project::
7171

7272
.. _Read the Docs README: https://github.com/rtfd/readthedocs.org/blob/master/README.rst
7373
.. _project page: https://readthedocs.org/projects/pip/
74-
.. |green| image:: https://media.readthedocs.org/static/projects/badges/passing-flat.svg
75-
.. |red| image:: https://media.readthedocs.org/static/projects/badges/failing-flat.svg
76-
.. |yellow| image:: https://media.readthedocs.org/static/projects/badges/unknown-flat.svg
74+
.. |green| image:: https://assets.readthedocs.org/static/projects/badges/passing-flat.svg
75+
.. |red| image:: https://assets.readthedocs.org/static/projects/badges/failing-flat.svg
76+
.. |yellow| image:: https://assets.readthedocs.org/static/projects/badges/unknown-flat.svg
7777
.. |nbsp| unicode:: 0xA0
7878
:trim:

‎docs/builds.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ The build environment
119119

120120
The build process is executed inside Docker containers,
121121
by default the image used is ``readthedocs/build:2.0``,
122-
but you can change that using a :doc:`configuration file <yaml-config>`.
122+
but you can change that using a :doc:`config-file/index`.
123123

124124
.. note::
125125

‎docs/conda.rst

+1-9
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,7 @@ This work was funded by `Clinical Graphics`_ -- many thanks for their support of
1414
Activating Conda
1515
----------------
1616

17-
Conda Support is the first feature enabled with :doc:`yaml-config`.
18-
You can enable it by creating a `readthedocs.yml` file in the root of your
19-
repository with the contents:
20-
21-
.. code-block:: yaml
22-
23-
conda:
24-
file: environment.yml
17+
Conda support is avalible using a :doc:`config-file/index`, see :ref:`config-file/v2:conda`.
2518

2619
This Conda environment will also have Sphinx and other build time dependencies installed.
2720
It will use the same order of operations that we support currently:
@@ -42,4 +35,3 @@ we can't safely install it as a normal dependency into the normal Python virtual
4235

4336
.. _issue: https://github.com/rtfd/readthedocs.org/issues
4437
.. _Clinical Graphics: https://www.clinicalgraphics.com/
45-

‎docs/config-file/index.rst

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Configuration File
2+
==================
3+
4+
In addition to using the admin panel of your project to configure your project,
5+
you can use a configuration file in the root of your project.
6+
The configuration file can be named as:
7+
8+
- ``readthedocs.yml``
9+
- ``readthedocs.yaml``
10+
- ``.readthedocs.yml``
11+
- ``.readthedocs.yaml``
12+
13+
The main advantages of using a configuration file over the web interface are:
14+
15+
- Some settings are only available using a configuration file
16+
- The settings are per version rather than per project.
17+
- The settings live in your VCS.
18+
- Reproducible build environments over time.
19+
20+
.. tip::
21+
22+
Using a configuration file is the recommended way of using Read the Docs.
23+
24+
.. toctree::
25+
:maxdepth: 3
26+
27+
Version 2 <v2>
28+
Version 1 <v1>

‎docs/yaml-config.rst renamed to ‎docs/config-file/v1.rst

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
Read the Docs YAML Config
2-
=========================
1+
Configuration File V1
2+
=====================
33

44
Read the Docs now has support for configuring builds with a YAML file.
5-
The file, ``readthedocs.yml``, must be in the root directory of your project.
5+
:doc:`The Read the Docs file <index>` must be in the root directory of your project.
66

7-
.. warning:: This feature is in a beta state.
8-
Please file an `issue`_ if you find anything wrong.
7+
.. warning::
98

9+
Version 1 shouldn't be used.
10+
The version 2 of the configuration file is now avaliable.
11+
See the :ref:`new features <config-file/v2:New settings>`
12+
and :ref:`how to migrate from v1 <config-file/v2:Migrating from v1>`.
1013

1114
Here is an example of what this file looks like:
1215

@@ -25,6 +28,15 @@ Here is an example of what this file looks like:
2528
Supported settings
2629
------------------
2730

31+
version
32+
~~~~~~~
33+
34+
* Default: 1
35+
36+
.. code-block:: yaml
37+
38+
version: 1
39+
2840
.. _yaml__formats:
2941

3042
formats
@@ -161,7 +173,7 @@ python.use_system_site_packages
161173
* Type: Boolean
162174

163175
When true, it gives the virtual environment access to the global site-packages directory.
164-
Depending on the :ref:`yaml-config:build.image`,
176+
Depending on the :ref:`config-file/v1:build.image`,
165177
Read the Docs includes some libraries like scipy, numpy, etc.
166178
See :ref:`builds:The build environment` for more details.
167179

0 commit comments

Comments
 (0)