@@ -9,8 +9,8 @@ Files: `tasks.py`_ - `doc_builder/`_
9
9
Every documentation build has limited resources.
10
10
Our current build limits are:
11
11
12
- * 15 minutes
13
- * 1GB of memory
12
+ * 15 minutes of CPU
13
+ * 1GB of RAM memory
14
14
15
15
We can increase build limits on a per-project basis,
16
16
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
73
73
74
74
Then we build the proper backend code for the type of documentation you've selected.
75
75
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 `.
78
79
79
80
When we build your Sphinx documentation, we run ``sphinx-build -b html . _build/html ``,
80
81
where ``html `` would be replaced with the correct backend.
@@ -89,13 +90,17 @@ An example in code:
89
90
.. code-block :: python
90
91
91
92
update_docs_from_vcs(version)
92
- if exists(' setup.py' ):
93
+ config = get_config(project)
94
+ if config.python.install.method.setuptools:
93
95
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)
96
100
build_docs(version = version)
97
101
copy_files(artifact_dir)
98
102
103
+
99
104
.. note ::
100
105
101
106
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
179
184
.. tip ::
180
185
181
186
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