Skip to content

Commit 23ca27a

Browse files
authored
Merge pull request #6993 from readthedocs/humitos/concurrent-limit-docs
2 parents d3fdb3b + cf305bd commit 23ca27a

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

docs/builds.rst

+13-17
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
Build Process
22
=============
33

4-
Files: `tasks.py`_ - `doc_builder/`_
5-
6-
.. _tasks.py: https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/projects/tasks.py
7-
.. _doc_builder/: https://github.com/rtfd/readthedocs.org/tree/master/readthedocs/doc_builder
8-
94
Every documentation build has limited resources.
105
Our current build limits are:
116

127
* 15 minutes of CPU
13-
* 1GB of RAM memory
8+
* 3GB of RAM memory
9+
* 2 concurrent builds
1410

1511
We can increase build limits on a per-project basis,
1612
sending an email to [email protected] providing a good reason why your documentation needs more resources.
@@ -50,13 +46,13 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository.
5046
If we don't find one,
5147
we will generate one for you.
5248

53-
Then MkDocs will build any files with a ``.md`` extension within the directory specified as ``docs_dir`` in the ``mkdocs.yml``.
49+
Then MkDocs will build any files with a ``.md`` extension within the directory specified as ``docs_dir`` in the ``mkdocs.yml``.
5450

55-
If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you,
56-
Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory.
51+
If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you,
52+
Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory.
5753
The first of these directories that exists and contains files with a ``.md`` extension will be set to ``docs_dir`` within ``mkdocs.yml``,
58-
and MkDocs will build the ``.md`` files in that directory.
59-
As MkDocs doesn't support automatic PDF generation,
54+
and MkDocs will build the ``.md`` files in that directory.
55+
As MkDocs doesn't support automatic PDF generation,
6056
Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option.
6157

6258
.. warning::
@@ -86,7 +82,7 @@ We also create pdf's and ePub's automatically based on your project.
8682
For MkDocs, we run ``mkdocs build``.
8783

8884
Then these files are copied across to our application servers from the build server.
89-
Once on the application servers, they are served from nginx.
85+
Once on the application servers, they are served from nginx.
9086

9187
An example in code:
9288

@@ -130,14 +126,14 @@ by default the image used is ``readthedocs/build:latest``,
130126
but you can change that using a :doc:`config-file/index`.
131127

132128
.. note::
133-
129+
134130
The Docker images have a select number of C libraries installed,
135131
because they are used across a wide array of python projects.
136132
We can't install every C library out there,
137133
but we try and support the major ones.
138134

139135
.. tip::
140-
136+
141137
If you want to know the specific version of a package that is installed in the image
142138
you can check the `Ubuntu package search page <https://packages.ubuntu.com/>`__.
143139

@@ -177,9 +173,9 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
177173
.. csv-table::
178174
:header-rows: 1
179175

180-
Environment variable, Description, Example value
181-
``READTHEDOCS``, Whether the build is running inside RTD, ``True``
182-
``READTHEDOCS_VERSION``, The RTD name of the version which is being built, ``latest``
176+
Environment variable, Description, Example value
177+
``READTHEDOCS``, Whether the build is running inside RTD, ``True``
178+
``READTHEDOCS_VERSION``, The RTD name of the version which is being built, ``latest``
183179
``READTHEDOCS_PROJECT``, The RTD slug of the project which is being built, ``my-example-project``
184180
``READTHEDOCS_LANGUAGE``, The RTD language slug of the project which is being built, ``en``
185181

0 commit comments

Comments
 (0)