Skip to content

Commit fab96ac

Browse files
committed
doc: adapt index for non-html output
Only generate images at the top for html output. Move TOC tree definition at the end and use it only on html output. Adapt section underlining to cope with sourcing of this document into another. Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 633dfed commit fab96ac

File tree

1 file changed

+66
-64
lines changed

1 file changed

+66
-64
lines changed

doc/source/index.rst

Lines changed: 66 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,26 @@
33
Environment Modules
44
===================
55

6-
.. image:: https://img.shields.io/github/stars/envmodules/modules
7-
:target: https://github.com/envmodules/modules
8-
:alt: GitHub Repository
6+
.. only:: html
97

10-
.. image:: https://img.shields.io/github/license/envmodules/modules?color=lightsteelblue
11-
:alt: GitHub License
8+
.. image:: https://img.shields.io/github/stars/envmodules/modules
9+
:target: https://github.com/envmodules/modules
10+
:alt: GitHub Repository
1211

13-
.. image:: https://img.shields.io/github/v/release/envmodules/modules
14-
:target: https://github.com/envmodules/modules/releases/latest
15-
:alt: GitHub Release
12+
.. image:: https://img.shields.io/github/license/envmodules/modules?color=lightsteelblue
13+
:alt: GitHub License
1614

17-
.. image:: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpublic.api.bsky.app%2Fxrpc%2Fapp.bsky.actor.getProfile%2F%3Factor%3Denvmodules.bsky.social&query=%24.followersCount&style=social&logo=bluesky&label=%40EnvModules
18-
:target: https://bsky.app/profile/envmodules.bsky.social
19-
:alt: Bluesky
15+
.. image:: https://img.shields.io/github/v/release/envmodules/modules
16+
:target: https://github.com/envmodules/modules/releases/latest
17+
:alt: GitHub Release
2018

21-
.. image:: https://img.shields.io/matrix/modules%3Amatrix.org?color=darkcyan
22-
:target: https://matrix.to/#/#modules:matrix.org
23-
:alt: Matrix
19+
.. image:: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpublic.api.bsky.app%2Fxrpc%2Fapp.bsky.actor.getProfile%2F%3Factor%3Denvmodules.bsky.social&query=%24.followersCount&style=social&logo=bluesky&label=%40EnvModules
20+
:target: https://bsky.app/profile/envmodules.bsky.social
21+
:alt: Bluesky
2422

23+
.. image:: https://img.shields.io/matrix/modules%3Amatrix.org?color=darkcyan
24+
:target: https://matrix.to/#/#modules:matrix.org
25+
:alt: Matrix
2526

2627
**Welcome to the Environment Modules documentation portal. The Environment
2728
Modules package provides for the dynamic modification of a user's environment
@@ -55,7 +56,7 @@ different applications.
5556
capabilities to scripts.
5657

5758
Quick examples
58-
--------------
59+
^^^^^^^^^^^^^^
5960

6061
Here is an example of loading a module on a Linux machine under bash.
6162
::
@@ -88,51 +89,8 @@ Now we'll log into a different machine, using a different shell (tcsh).
8889
Note that the command line is exactly the same, but the path has
8990
automatically configured to the correct architecture.
9091

91-
.. toctree::
92-
:hidden:
93-
:maxdepth: 2
94-
:caption: Basics
95-
96-
INSTALL
97-
INSTALL-win
98-
MIGRATING
99-
NEWS
100-
FAQ
101-
changes
102-
other-implementations
103-
104-
.. toctree::
105-
:hidden:
106-
:maxdepth: 2
107-
:caption: Examples
108-
109-
cookbook
110-
111-
.. toctree::
112-
:hidden:
113-
:maxdepth: 2
114-
:caption: Reference
115-
116-
ml
117-
module
118-
modulefile
119-
envml
120-
121-
.. toctree::
122-
:hidden:
123-
:maxdepth: 2
124-
:caption: Development
125-
126-
CONTRIBUTING
127-
devel
128-
design
129-
CHARTER
130-
GOVERNANCE
131-
acknowledgments
132-
133-
13492
Get started with Modules
135-
------------------------
93+
^^^^^^^^^^^^^^^^^^^^^^^^
13694

13795
Learn how to retrieve and install Modules :ref:`on Unix<INSTALL>` or
13896
:ref:`on Windows<INSTALL-win>`. An overlook on the new functionalities
@@ -150,7 +108,7 @@ Modules and how to extend the :command:`module` command to achieve specific
150108
needs.
151109

152110
Links
153-
-----
111+
^^^^^
154112

155113
* Web site: https://envmodules.io
156114
* Documentation: https://modules.readthedocs.io
@@ -161,7 +119,7 @@ Links
161119
.. _Community:
162120

163121
Community
164-
---------
122+
^^^^^^^^^
165123

166124
Modules is an open source project. Questions, discussion, and contributions
167125
are welcome. You can get in contact with the Modules community via:
@@ -183,7 +141,7 @@ The project is also present on several social media platforms:
183141
.. _@EnvModules.bsky.social: https://bsky.app/profile/envmodules.bsky.social
184142

185143
Contributing
186-
------------
144+
^^^^^^^^^^^^
187145

188146
Modules project welcomes contributions of all kinds! Before submitting an
189147
issue or pull request, please take a moment to review our :ref:`Contributing
@@ -197,7 +155,7 @@ the Modules community, you agree to abide by its rules.
197155
.. _Code of conduct: https://github.com/envmodules/modules?tab=coc-ov-file#readme
198156

199157
Governance
200-
----------
158+
^^^^^^^^^^
201159

202160
Modules is part of the `High Performance Software Foundation`_ within the
203161
`Linux Foundation`_.
@@ -209,7 +167,51 @@ governance model, decision-making process, and long-term vision.
209167
.. _Linux Foundation: http://linuxfoundation.org
210168

211169
License
212-
-------
170+
^^^^^^^
213171

214172
Modules is distributed under the GNU General Public License, either version 2
215173
or (at your option) any later version (`GPL-2.0-or-later`).
174+
175+
.. only:: html
176+
177+
.. toctree::
178+
:hidden:
179+
:maxdepth: 2
180+
:caption: Basics
181+
182+
INSTALL
183+
INSTALL-win
184+
MIGRATING
185+
NEWS
186+
FAQ
187+
changes
188+
other-implementations
189+
190+
.. toctree::
191+
:hidden:
192+
:maxdepth: 2
193+
:caption: Examples
194+
195+
cookbook
196+
197+
.. toctree::
198+
:hidden:
199+
:maxdepth: 2
200+
:caption: Reference
201+
202+
ml
203+
module
204+
modulefile
205+
envml
206+
207+
.. toctree::
208+
:hidden:
209+
:maxdepth: 2
210+
:caption: Development
211+
212+
CONTRIBUTING
213+
devel
214+
design
215+
CHARTER
216+
GOVERNANCE
217+
acknowledgments

0 commit comments

Comments
 (0)