|
1 |
| -Downloadable Documentation |
2 |
| -========================== |
| 1 | +Offline Formats |
| 2 | +=============== |
3 | 3 |
|
4 |
| -Read the Docs supports building multiple formats for Sphinx-based projects: |
| 4 | +Read the Docs supports building multiple offline formats: |
5 | 5 |
|
6 | 6 | * PDF
|
7 | 7 | * ePub
|
8 | 8 | * Zipped HTML
|
9 | 9 |
|
10 |
| -This means that every commit that you push will automatically update your PDFs as well as your HTML. |
11 |
| - |
12 |
| -This is enabled by the :ref:`config-file/v2:formats` key in our config file. |
13 |
| -A simple example is here: |
14 |
| - |
15 |
| -.. code-block:: yaml |
16 |
| -
|
17 |
| - # Build PDF & ePub |
18 |
| - formats: |
19 |
| - - epub |
20 |
| - - pdf |
21 |
| -
|
22 |
| -If you want to see an example, |
23 |
| -you can download the Read the Docs documentation in the following formats: |
24 |
| - |
25 |
| - * `PDF`_ |
26 |
| - * `ePub`_ |
27 |
| - * `Zipped HTML`_ |
28 |
| - |
29 |
| -.. _PDF: https://docs.readthedocs.io/_/downloads/en/latest/pdf/ |
30 |
| -.. _ePub: https://docs.readthedocs.io/_/downloads/en/latest/epub/ |
31 |
| -.. _Zipped HTML: https://docs.readthedocs.io/_/downloads/en/latest/htmlzip/ |
| 10 | +This means that every commit that you push will automatically update your these offline formats as well as your HTML. |
32 | 11 |
|
33 | 12 | Use cases
|
34 | 13 | ---------
|
35 | 14 |
|
36 | 15 | This functionality is great for anyone who needs documentation when they aren't connected to the internet.
|
37 | 16 | Users who are about to get on a plane can grab a PDF and have the entire doc set ready for their trip.
|
38 | 17 |
|
39 |
| -The other value is having the entire docset in a single file. |
| 18 | +The other value is having the entire documentation in a single file. |
40 | 19 | You can send a user an email with a single PDF or ePub and they'll have all the docs in one place.
|
| 20 | +This is useful for archiving documentation, as well as distributing it in other scenarios. |
41 | 21 |
|
42 |
| -Deleting downloadable content |
43 |
| ------------------------------ |
| 22 | +Accessing offline formats |
| 23 | +------------------------- |
44 | 24 |
|
45 |
| -The entries in the Downloads section of your project dashboard reflect the |
46 |
| -formats specified in your config file for each active version. |
| 25 | +You can download offline formats in the :guilabel:`Project dashboard` > :guilabel:`Downloads`: |
47 | 26 |
|
48 |
| -This means that if you wish to remove downloadable content for a given version, |
49 |
| -you can do so by removing the matching :ref:`config-file/v2:formats` key from |
50 |
| -your config file. |
| 27 | +.. image:: /_static/images/guides/offline-formats.jpg |
| 28 | + :width: 75% |
| 29 | + |
| 30 | +Examples |
| 31 | +-------- |
| 32 | + |
| 33 | +If you want to see an example, |
| 34 | +you can download the Read the Docs documentation in the following formats: |
| 35 | + |
| 36 | + * `PDF`_ |
| 37 | + * `ePub`_ |
| 38 | + * `Zipped HTML`_ |
| 39 | + |
| 40 | +.. _PDF: https://docs.readthedocs.io/_/downloads/en/latest/pdf/ |
| 41 | +.. _ePub: https://docs.readthedocs.io/_/downloads/en/latest/epub/ |
| 42 | +.. _Zipped HTML: https://docs.readthedocs.io/_/downloads/en/latest/htmlzip/ |
0 commit comments