@@ -51,13 +51,13 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository.
51
51
If we don't find one,
52
52
we will generate one for you.
53
53
54
- Then MkDocs will build any files with a ``.md `` extension within the directory specified as ``docs_dir `` in the ``mkdocs.yml ``.
54
+ Then MkDocs will build any files with a ``.md `` extension within the directory specified as ``docs_dir `` in the ``mkdocs.yml ``.
55
55
56
- If no ``mkdocs.yml `` was found in the root of your repository and we generated one for you,
57
- Read the Docs will attempt to set ``docs_dir `` by sequentially searching for a ``docs ``, ``doc ``, ``Doc ``, or ``book `` directory.
56
+ If no ``mkdocs.yml `` was found in the root of your repository and we generated one for you,
57
+ Read the Docs will attempt to set ``docs_dir `` by sequentially searching for a ``docs ``, ``doc ``, ``Doc ``, or ``book `` directory.
58
58
The first of these directories that exists and contains files with a ``.md `` extension will be set to ``docs_dir `` within ``mkdocs.yml ``,
59
- and MkDocs will build the ``.md `` files in that directory.
60
- As MkDocs doesn't support automatic PDF generation,
59
+ and MkDocs will build the ``.md `` files in that directory.
60
+ As MkDocs doesn't support automatic PDF generation,
61
61
Read the Docs cannot create a PDF version of your documentation with the *Mkdocs * option.
62
62
63
63
.. warning ::
@@ -87,7 +87,7 @@ We also create pdf's and ePub's automatically based on your project.
87
87
For MkDocs, we run ``mkdocs build ``.
88
88
89
89
Then these files are copied across to our application servers from the build server.
90
- Once on the application servers, they are served from nginx.
90
+ Once on the application servers, they are served from nginx.
91
91
92
92
An example in code:
93
93
@@ -131,14 +131,14 @@ by default the image used is ``readthedocs/build:latest``,
131
131
but you can change that using a :doc: `config-file/index `.
132
132
133
133
.. note ::
134
-
134
+
135
135
The Docker images have a select number of C libraries installed,
136
136
because they are used across a wide array of python projects.
137
137
We can't install every C library out there,
138
138
but we try and support the major ones.
139
139
140
140
.. tip ::
141
-
141
+
142
142
If you want to know the specific version of a package that is installed in the image
143
143
you can check the `Ubuntu package search page <https://packages.ubuntu.com/ >`__.
144
144
@@ -178,9 +178,9 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
178
178
.. csv-table ::
179
179
:header-rows: 1
180
180
181
- Environment variable, Description, Example value
182
- ``READTHEDOCS ``, Whether the build is running inside RTD, ``True ``
183
- ``READTHEDOCS_VERSION ``, The RTD name of the version which is being built, ``latest ``
181
+ Environment variable, Description, Example value
182
+ ``READTHEDOCS ``, Whether the build is running inside RTD, ``True ``
183
+ ``READTHEDOCS_VERSION ``, The RTD name of the version which is being built, ``latest ``
184
184
``READTHEDOCS_PROJECT ``, The RTD slug of the project which is being built, ``my-example-project ``
185
185
``READTHEDOCS_LANGUAGE ``, The RTD language slug of the project which is being built, ``en ``
186
186
0 commit comments