|
1 | 1 | Build Process
|
2 | 2 | =============
|
3 | 3 |
|
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 |
| - |
9 | 4 | Every documentation build has limited resources.
|
10 | 5 | Our current build limits are:
|
11 | 6 |
|
12 | 7 | * 15 minutes of CPU
|
13 |
| -* 1GB of RAM memory |
| 8 | +* 3GB of RAM memory |
| 9 | +* 2 concurrent builds |
14 | 10 |
|
15 | 11 | We can increase build limits on a per-project basis,
|
16 | 12 | 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.
|
50 | 46 | If we don't find one,
|
51 | 47 | we will generate one for you.
|
52 | 48 |
|
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``. |
54 | 50 |
|
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. |
57 | 53 | 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, |
60 | 56 | Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option.
|
61 | 57 |
|
62 | 58 | .. warning::
|
@@ -86,7 +82,7 @@ We also create pdf's and ePub's automatically based on your project.
|
86 | 82 | For MkDocs, we run ``mkdocs build``.
|
87 | 83 |
|
88 | 84 | 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. |
90 | 86 |
|
91 | 87 | An example in code:
|
92 | 88 |
|
@@ -130,14 +126,14 @@ by default the image used is ``readthedocs/build:latest``,
|
130 | 126 | but you can change that using a :doc:`config-file/index`.
|
131 | 127 |
|
132 | 128 | .. note::
|
133 |
| - |
| 129 | + |
134 | 130 | The Docker images have a select number of C libraries installed,
|
135 | 131 | because they are used across a wide array of python projects.
|
136 | 132 | We can't install every C library out there,
|
137 | 133 | but we try and support the major ones.
|
138 | 134 |
|
139 | 135 | .. tip::
|
140 |
| - |
| 136 | + |
141 | 137 | If you want to know the specific version of a package that is installed in the image
|
142 | 138 | you can check the `Ubuntu package search page <https://packages.ubuntu.com/>`__.
|
143 | 139 |
|
@@ -177,9 +173,9 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
|
177 | 173 | .. csv-table::
|
178 | 174 | :header-rows: 1
|
179 | 175 |
|
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`` |
183 | 179 | ``READTHEDOCS_PROJECT``, The RTD slug of the project which is being built, ``my-example-project``
|
184 | 180 | ``READTHEDOCS_LANGUAGE``, The RTD language slug of the project which is being built, ``en``
|
185 | 181 |
|
|
0 commit comments