Skip to content

Commit cadd062

Browse files
nashifcfriedt
authored andcommitted
doc: create an index for PDF files
Most of the content in the default index is HTML only, so create an index just for PDF and keep it clean. Signed-off-by: Anas Nashif <[email protected]>
1 parent dd256ee commit cadd062

File tree

3 files changed

+40
-24
lines changed

3 files changed

+40
-24
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158
}
159159

160160
latex_documents = [
161-
("index", "zephyr.tex", "Zephyr Project Documentation", "many", "manual"),
161+
("index-tex", "zephyr.tex", "Zephyr Project Documentation", "many", "manual"),
162162
]
163163

164164
# -- Options for zephyr.doxyrunner plugin ---------------------------------

doc/index-tex.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:orphan:
2+
3+
..
4+
Zephyr Project documentation main file
5+
6+
.. _zephyr-home-tex:
7+
8+
Zephyr Project Documentation
9+
############################
10+
11+
12+
.. toctree::
13+
:maxdepth: 1
14+
:caption: Contents
15+
16+
introduction/index.rst
17+
getting_started/index.rst
18+
contribute/index.rst
19+
development_process/index.rst
20+
guides/build/index.rst
21+
application/index.rst
22+
reference/index.rst
23+
guides/index.rst
24+
security/index.rst

doc/index.rst

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,16 @@ Zephyr Project Documentation
1818
**Welcome to the Zephyr Project's documentation
1919
for the main tree under development** (version |version|).
2020

21-
.. only:: html
21+
Use the version selection menu on the left to view
22+
documentation for a specific version of Zephyr.
2223

23-
Use the version selection menu on the left to view
24-
documentation for a specific version of Zephyr.
24+
For information about the changes and additions for releases, please
25+
consult the published :ref:`zephyr_release_notes` documentation.
2526

26-
For information about the changes and additions for releases, please
27-
consult the published :ref:`zephyr_release_notes` documentation.
28-
29-
The Zephyr OS is provided under the `Apache 2.0 license`_ (as found in
30-
the LICENSE file in the project's `GitHub repo`_). The Zephyr OS also
31-
imports or reuses packages, scripts, and other files that use other
32-
licensing, as described in :ref:`Zephyr_Licensing`.
27+
The Zephyr OS is provided under the `Apache 2.0 license`_ (as found in
28+
the LICENSE file in the project's `GitHub repo`_). The Zephyr OS also
29+
imports or reuses packages, scripts, and other files that use other
30+
licensing, as described in :ref:`Zephyr_Licensing`.
3331

3432

3533
.. raw:: html
@@ -96,10 +94,8 @@ Zephyr Project Documentation
9694
</li>
9795
</ul>
9896

99-
.. only:: html
100-
101-
Sections
102-
********
97+
Sections
98+
********
10399

104100
.. toctree::
105101
:maxdepth: 1
@@ -118,16 +114,12 @@ Zephyr Project Documentation
118114
boards/index.rst
119115
releases/index.rst
120116

121-
.. only:: html
122-
123-
Indices and Tables
124-
******************
125-
126-
.. only:: html
117+
Indices and Tables
118+
******************
127119

128-
* :ref:`configuration_options`
129-
* :ref:`glossary`
130-
* :ref:`genindex`
120+
* :ref:`configuration_options`
121+
* :ref:`glossary`
122+
* :ref:`genindex`
131123

132124
.. _Apache 2.0 license:
133125
https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE

0 commit comments

Comments
 (0)