You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/specifying-dependencies.rst
+8-13Lines changed: 8 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ Any dependencies required for building a documentation project can be specified
7
7
8
8
Specifying a requirements file
9
9
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10
+
10
11
The requirements file option is useful for specifying dependencies required for building the documentation. Additional uses specific to Read the Docs are mentioned at the end of this guide.
11
12
12
13
For details about the purpose of pip requirements file and how to create one, check out `pip user guide`_
@@ -17,7 +18,8 @@ To use the requirements file, create and place the requirements file in the root
17
18
18
19
Using the YAML configuration file
19
20
---------------------------------
20
-
The recommended approach for specifying a pip requirements file is to use a readthedocs.yml file.
21
+
22
+
The recommended approach for specifying a pip requirements file is to use a ``readthedocs.yml`` file.
21
23
22
24
The file's path should be relative to documentation root.
23
25
@@ -38,6 +40,7 @@ Once the requirements file has been created;
38
40
39
41
Using a conda environment file
40
42
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
+
41
44
If using conda, the dependencies can be specified in the conda environment file, ``environment.yml`` .
42
45
43
46
More on Read the Doc's conda support: :doc:`conda`
@@ -50,18 +53,10 @@ This conda environment file can be specified in ``readthedocs.yml`` in the ``con
50
53
51
54
.. code-block:: yaml
52
55
53
-
conda:
54
-
file: environment.yml
56
+
conda:
57
+
file: environment.yml
55
58
56
59
As before, the path should be relative to the documentation repository root.
57
60
58
-
Additional Uses
59
-
~~~~~~~~~~~~~~~
60
-
- Documenting multiple packages
61
-
- setup.py not in root directory
62
-
63
-
See :ref:`faq_document_package_not_at_root`
64
-
65
-
66
-
.. _`pip user guide`: :https://pip.pypa.io/en/stable/user_guide/#requirements-files
67
-
.. _`conda and environment.yml`: :https://conda.io/docs/user-guide/tasks/manage-environments.html
61
+
.. _`pip user guide`: https://pip.pypa.io/en/stable/user_guide/#requirements-files
62
+
.. _`conda and environment.yml`: https://conda.io/docs/user-guide/tasks/manage-environments.html
0 commit comments