File tree 1 file changed +17
-0
lines changed
1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -51,6 +51,23 @@ All :doc:`build processes </builds>` have the following environment variables au
51
51
52
52
:Example: ``/home/docs/checkouts/readthedocs.org/user_builds/project/envs/version ``
53
53
54
+ .. envvar :: READTHEDOCS_OUTPUT
55
+
56
+ Base path for well-known output directories. Files in these directories will automatically be found, uploaded and published.
57
+
58
+ You need to concatenate an output format to this variable.
59
+ Currently valid formats are ``html ``, ``pdf ``, ``htmlzip `` and ``epub ``.
60
+ (e.g. ``$READTHEDOCS_OUTPUT/html/ `` or ``$READTHEDOCS_OUTPUT/pdf/ ``)
61
+ You also need to create the directory before moving outputs into the destination.
62
+ You can create it with the following command ``mkdir -p $READTHEDOCS_OUTPUT/html/ ``.
63
+ Note that only ``html `` supports multiple files,
64
+ the other formats should have one and only one file to be uploaded.
65
+
66
+ .. seealso ::
67
+
68
+ :ref: `build-customization:where to put files `
69
+ Information about using custom commands to generate output that will automatically be published once your build succeeds.
70
+
54
71
.. envvar :: READTHEDOCS_CANONICAL_URL
55
72
56
73
Canonical base URL for the version that is built.
You can’t perform that action at this time.
0 commit comments