Skip to content

Commit 0917fbd

Browse files
authored
Merge pull request readthedocs#5398 from rtfd/humitos/update-builds-docs
Minimum upgrade of the builds docs
2 parents b6d6528 + a1e33af commit 0917fbd

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/builds.rst

+14-8
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Files: `tasks.py`_ - `doc_builder/`_
99
Every documentation build has limited resources.
1010
Our current build limits are:
1111

12-
* 15 minutes
13-
* 1GB of memory
12+
* 15 minutes of CPU
13+
* 1GB of RAM memory
1414

1515
We can increase build limits on a per-project basis,
1616
if you provide a good reason your documentation needs more resources.
@@ -73,8 +73,9 @@ If the code is already checked out, we update the copy to the branch that you ha
7373

7474
Then we build the proper backend code for the type of documentation you've selected.
7575

76-
If you have the *Install Project* option enabled, we will run ``setup.py install`` on your package, installing it into a virtual environment.
77-
You can also define additional packages to install with the *Requirements File* option.
76+
At this point, if you need extra requirements,
77+
or even install your own package in the virtual environment to build your documentation,
78+
you can use a :doc:`config-file/index`.
7879

7980
When we build your Sphinx documentation, we run ``sphinx-build -b html . _build/html``,
8081
where ``html`` would be replaced with the correct backend.
@@ -89,13 +90,17 @@ An example in code:
8990
.. code-block:: python
9091
9192
update_docs_from_vcs(version)
92-
if exists('setup.py'):
93+
config = get_config(project)
94+
if config.python.install.method.setuptools:
9395
run('python setup.py install')
94-
if project.requirements_file:
95-
run('pip install -r %s' % project.requirements_file)
96+
if config.python.install.method.pip:
97+
run('pip install .')
98+
if config.python.install.requirement:
99+
run('pip install -r %s' % config.python.install.requirement)
96100
build_docs(version=version)
97101
copy_files(artifact_dir)
98102
103+
99104
.. note::
100105

101106
Regardless of whether you build your docs with Sphinx or MkDocs,
@@ -179,4 +184,5 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
179184
.. tip::
180185

181186
In case extra environment variables are needed to the build process (like secrets, tokens, etc),
182-
you can add them going to **Admin > Environment Variables** in your project. See :doc:`guides/environment-variables`.
187+
you can add them going to :guilabel:`Admin` > :guilabel:`Environment Variables` in your project.
188+
See :doc:`guides/environment-variables`.

0 commit comments

Comments
 (0)