Skip to content

Commit 8457bbf

Browse files
committed
Refactor offline formats docs
Refs #9746 Closes #9577
1 parent cc1c767 commit 8457bbf

File tree

4 files changed

+66
-33
lines changed

4 files changed

+66
-33
lines changed
Loading
+25-33
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,42 @@
1-
Downloadable Documentation
2-
==========================
1+
Offline Formats
2+
===============
33

4-
Read the Docs supports building multiple formats for Sphinx-based projects:
4+
Read the Docs supports building multiple offline formats:
55

66
* PDF
77
* ePub
88
* Zipped HTML
99

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.
3211

3312
Use cases
3413
---------
3514

3615
This functionality is great for anyone who needs documentation when they aren't connected to the internet.
3716
Users who are about to get on a plane can grab a PDF and have the entire doc set ready for their trip.
3817

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.
4019
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.
4121

42-
Deleting downloadable content
43-
-----------------------------
22+
Accessing offline formats
23+
-------------------------
4424

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`:
4726

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/

docs/user/guides/authors.rst

+1
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ and :doc:`/intro/getting-started-with-mkdocs`.
1717
Link to external projects (Intersphinx) <intersphinx>
1818
jupyter
1919
Migrate from rST to MyST <migrate-rest-myst>
20+
enable-offline-formats
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
How to enable offline formats
2+
=============================
3+
4+
This guide provides a step-by-step guide to enabling offline formats of your documentation.
5+
6+
They are automatically built by Read the Docs during our default build process,
7+
as long as you have the configuration enabled to turn this on.
8+
9+
.. note:: Offline formats are currently only available for Sphinx-based documentation when using the Read the Docs build process.
10+
11+
Enabling offline formats
12+
------------------------
13+
14+
Offline formats are enabled by the :ref:`config-file/v2:formats` key in our config file.
15+
A simple example is here:
16+
17+
.. code-block:: yaml
18+
19+
# Build PDF & ePub
20+
formats:
21+
- epub
22+
- pdf
23+
24+
Verifying offline formats
25+
-------------------------
26+
27+
You can verify that offline formats are building in your :guilabel:`Project dashboard` > :guilabel:`Downloads`:
28+
29+
.. image:: /_static/images/guides/offline-formats.jpg
30+
:width: 75%
31+
32+
Deleting offline formats
33+
------------------------
34+
35+
The entries in the Downloads section of your project dashboard reflect the
36+
formats specified in your config file for each active version.
37+
38+
This means that if you wish to remove downloadable content for a given version,
39+
you can do so by removing the matching :ref:`config-file/v2:formats` key from
40+
your config file.

0 commit comments

Comments
 (0)