From b3831f55c80c812ae45eec86027aa0e6b199068b Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 29 Apr 2020 15:23:44 +0200 Subject: [PATCH 1/4] Mention 2 concurrent builds in limited resources --- docs/builds.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/builds.rst b/docs/builds.rst index c435e07e1e3..d35a3d6242c 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -11,6 +11,7 @@ Our current build limits are: * 15 minutes of CPU * 1GB of RAM memory +* 2 concurrent builds We can increase build limits on a per-project basis, sending an email to support@readthedocs.org providing a good reason why your documentation needs more resources. From 904694cceff8686331dfed0a70e595c3fa76f31e Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 29 Apr 2020 15:24:18 +0200 Subject: [PATCH 2/4] Remove trailing whitespaces --- docs/builds.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/builds.rst b/docs/builds.rst index d35a3d6242c..e1cf6ccb01c 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -51,13 +51,13 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository. If we don't find one, we will generate one for you. -Then MkDocs will build any files with a ``.md`` extension within the directory specified as ``docs_dir`` in the ``mkdocs.yml``. +Then MkDocs will build any files with a ``.md`` extension within the directory specified as ``docs_dir`` in the ``mkdocs.yml``. -If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you, -Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory. +If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you, +Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory. The first of these directories that exists and contains files with a ``.md`` extension will be set to ``docs_dir`` within ``mkdocs.yml``, -and MkDocs will build the ``.md`` files in that directory. -As MkDocs doesn't support automatic PDF generation, +and MkDocs will build the ``.md`` files in that directory. +As MkDocs doesn't support automatic PDF generation, Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option. .. warning:: @@ -87,7 +87,7 @@ We also create pdf's and ePub's automatically based on your project. For MkDocs, we run ``mkdocs build``. Then these files are copied across to our application servers from the build server. -Once on the application servers, they are served from nginx. +Once on the application servers, they are served from nginx. An example in code: @@ -131,14 +131,14 @@ by default the image used is ``readthedocs/build:latest``, but you can change that using a :doc:`config-file/index`. .. note:: - + The Docker images have a select number of C libraries installed, because they are used across a wide array of python projects. We can't install every C library out there, but we try and support the major ones. .. tip:: - + If you want to know the specific version of a package that is installed in the image you can check the `Ubuntu package search page `__. @@ -178,9 +178,9 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va .. csv-table:: :header-rows: 1 - Environment variable, Description, Example value - ``READTHEDOCS``, Whether the build is running inside RTD, ``True`` - ``READTHEDOCS_VERSION``, The RTD name of the version which is being built, ``latest`` + Environment variable, Description, Example value + ``READTHEDOCS``, Whether the build is running inside RTD, ``True`` + ``READTHEDOCS_VERSION``, The RTD name of the version which is being built, ``latest`` ``READTHEDOCS_PROJECT``, The RTD slug of the project which is being built, ``my-example-project`` ``READTHEDOCS_LANGUAGE``, The RTD language slug of the project which is being built, ``en`` From e4a3be966b91b9ad6d12a6736ea991358cc4008c Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 29 Apr 2020 15:24:32 +0200 Subject: [PATCH 3/4] Remove files linked for build process from docs --- docs/builds.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/builds.rst b/docs/builds.rst index e1cf6ccb01c..d29464b438a 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -1,11 +1,6 @@ Build Process ============= -Files: `tasks.py`_ - `doc_builder/`_ - -.. _tasks.py: https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/projects/tasks.py -.. _doc_builder/: https://github.com/rtfd/readthedocs.org/tree/master/readthedocs/doc_builder - Every documentation build has limited resources. Our current build limits are: From cf305bde01c2aa929455cb4c7675dd39e439a15e Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Wed, 29 Apr 2020 15:58:12 +0200 Subject: [PATCH 4/4] Update RAM limit --- docs/builds.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/builds.rst b/docs/builds.rst index d29464b438a..214fa689caa 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -5,7 +5,7 @@ Every documentation build has limited resources. Our current build limits are: * 15 minutes of CPU -* 1GB of RAM memory +* 3GB of RAM memory * 2 concurrent builds We can increase build limits on a per-project basis,