Skip to content

Commit 52c4c92

Browse files
ehoganehogan
authored
Minimise content on main documentation page (#4449)
1 parent edd7cac commit 52c4c92

8 files changed

Lines changed: 118 additions & 103 deletions

File tree

‎doc/sphinx/source/_templates/contribute.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{#
2+
Displays a link to the contributing guidelines.
3+
Copied from https://github.com/pydata/pydata-sphinx-theme/blob/v0.17.0/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/edit-this-page.html
4+
and simplified.
5+
#}
6+
{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %}
7+
{% set src = sourcename.split('.') %}
8+
<div class="tocsection editthispage">
9+
<a href="{{ pathto('community/index') }}">
10+
<i class="fa-solid fa-pencil"></i>
11+
Contributions are welcome!
12+
</a>
13+
</div>
14+
{% endif %}

‎doc/sphinx/source/_templates/cross_proj_navbar.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
</a>
1313
</li>
1414
<li class="nav-item ">
15-
<a class="nav-link nav-external" href="https://tutorial.esmvaltool.org/">
16-
Tutorial
15+
<a class="nav-link nav-internal" href="{{ pathto('tutorials/index') }}">
16+
Tutorials
1717
</a>
1818
</li>
1919
<li class="nav-item ">

‎doc/sphinx/source/_templates/support.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{#
2+
Displays a link to support information.
3+
Modified version of 'contribute.html'
4+
#}
5+
<div class="tocsection editthispage">
6+
<a href="{{ pathto('support') }}">
7+
<i class="fa-solid fa-hand-holding-heart"></i>
8+
Support
9+
</a>
10+
</div>

‎doc/sphinx/source/conf.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@
164164
},
165165
"navbar_center": ["cross_proj_navbar"],
166166
"search_bar_text": "Search ESMValTool docs... (Also try search in ESMValCore docs)",
167+
"secondary_sidebar_items": ["page-toc", "sourcelink", "contribute", "support"],
168+
"use_edit_page_button": True,
167169
}
168170
# Add any paths that contain custom themes here, relative to this directory.
169171
# html_theme_path = []

‎doc/sphinx/source/index.rst‎

Lines changed: 14 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:html_theme.sidebar_secondary.remove:
2-
31
.. ESMValTool documentation master file, created by
42
sphinx-quickstart on Tue Jun 2 11:34:13 2015.
53
You can adapt this file completely to your liking, but it should at least
@@ -36,46 +34,25 @@ notebooks.
3634
:figclass: align-center
3735
:class: dark-light
3836

39-
40-
Learning resources:
41-
-------------------
42-
43-
A tutorial is available on https://tutorial.esmvaltool.org.
44-
45-
A series of video lectures has been created by `ACCESS-NRI <https://www.access-nri.org.au>`_.
46-
While these are tailored for ACCESS users, they are still very informative.
47-
48-
.. raw:: html
49-
50-
<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=pUXrXB8C8bLRfQHY&amp;list=PLFjfi2xLaFpJp59LvDc1upQsj_xzFlFLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
51-
52-
How to contribute
53-
-----------------
54-
Refer to ESMValTool :ref:`contributing to the community<community>` for a guide on contributing recipes and diagnostics.
55-
56-
Refer to ESMValCore contributing for information on contributing code.
57-
58-
Get in touch!
59-
-------------
60-
Contact information is available :ref:`here <Support-and-Contact>`.
61-
6237
.. toctree::
6338
:hidden:
6439
:maxdepth: 2
6540
:caption: ESMValTool
6641

67-
Introduction <introduction>
68-
ESMValTool Functionalities <functionalities>
69-
Gallery <gallery>
70-
Getting started <quickstart/index>
71-
Recipes <recipes/index>
72-
Diagnostics API Reference <api/esmvaltool>
73-
Obtaining input data <input>
74-
Making a recipe or diagnostic <develop/index>
75-
Contributing to the community <community/index>
76-
Utilities <utils/utils>
77-
Frequently Asked Questions <faq>
78-
Changelog <changelog>
42+
Introduction <introduction>
43+
Tutorials <tutorials/index>
44+
ESMValTool Functionalities <functionalities>
45+
Gallery <gallery>
46+
Getting started <quickstart/index>
47+
Recipes <recipes/index>
48+
Diagnostics API Reference <api/esmvaltool>
49+
Obtaining input data <input>
50+
Making a recipe or diagnostic <develop/index>
51+
Contributing to the community <community/index>
52+
Utilities <utils/utils>
53+
Frequently Asked Questions <faq>
54+
Changelog <changelog>
55+
Support <support>
7956

8057
Indices and tables
8158
------------------

‎doc/sphinx/source/introduction.rst‎

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -50,70 +50,6 @@ these challenging objectives the ESMValTool is conceived as a framework
5050
which allows community contributions to be bound into a coherent
5151
framework.
5252

53-
.. _Support-and-Contact:
54-
55-
Support
56-
=======
57-
58-
Support for ESMValTool can be found in `ESMValTool Discussions page
59-
<https://github.com/ESMValGroup/ESMValTool/discussions>`__
60-
where users can open an issue and a member of the `User Engagement Team
61-
<mailto:esmvaltool_user_engagement_team@listserv.dfn.de>`_ of ESMValTool
62-
will reply as soon as possible.
63-
This is open for all general and technical questions on the ESMValTool:
64-
installation, application, development, or any other question or comment
65-
you may have.
66-
67-
.. _mailing-list:
68-
69-
User mailing list
70-
-----------------
71-
72-
Subscribe to the ESMValTool announcements mailing list
73-
`esmvaltool@listserv.dfn.de <mailto:esmvaltool@listserv.dfn.de>`__
74-
to stay up to date about new releases, monthly online meetings, upcoming workshops, and trainings.
75-
76-
To subscribe, send an email to
77-
`sympa@listserv.dfn.de <mailto:sympa@listserv.dfn.de?subject=subscribe%20esmvaltool>`_
78-
with the following subject line:
79-
80-
- *subscribe esmvaltool*
81-
82-
or
83-
84-
- *subscribe esmvaltool YOUR_FIRSTNAME YOUR_LASTNAME*
85-
86-
The mailing list also has a `public archive <https://www.listserv.dfn.de/sympa/arc/esmvaltool>`_ online.
87-
88-
.. _monthly-meetings:
89-
90-
Monthly meetings
91-
----------------
92-
93-
We have monthly online meetings using `zoom <https://zoom.us/>`__, anyone with
94-
an interest in the ESMValTool is welcome to join these meetings to connect with
95-
the community.
96-
These meetings are always announced in a discussion
97-
on the `ESMValTool Community <https://github.com/ESMValGroup/Community/discussions>`_
98-
repository and on the mailing-list_.
99-
100-
.. _core-team:
101-
102-
Development team
103-
----------------
104-
105-
ESMValTool is developed by a community of scientists and research software
106-
engineers from multiple institutes. An overview of the team is available
107-
on the `development team page <https://esmvaltool.org/team/>`__.
108-
109-
Recipes and diagnostics
110-
-----------------------
111-
112-
Contacts for specific diagnostic sets are the respective authors, as
113-
listed in the corresponding :ref:`recipe and diagnostic documentation<recipes>`
114-
and in the source code.
115-
116-
11753
License
11854
=======
11955

‎doc/sphinx/source/support.rst‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
.. _Support-and-Contact:
2+
3+
Support
4+
*******
5+
6+
Support for ESMValTool can be found in `ESMValTool Discussions page
7+
<https://github.com/ESMValGroup/ESMValTool/discussions>`__
8+
where users can open an issue and a member of the `User Engagement Team
9+
<mailto:esmvaltool_user_engagement_team@listserv.dfn.de>`_ of ESMValTool
10+
will reply as soon as possible.
11+
This is open for all general and technical questions on the ESMValTool:
12+
installation, application, development, or any other question or comment
13+
you may have.
14+
15+
.. _mailing-list:
16+
17+
User mailing list
18+
-----------------
19+
20+
Subscribe to the ESMValTool announcements mailing list
21+
`esmvaltool@listserv.dfn.de <mailto:esmvaltool@listserv.dfn.de>`__
22+
to stay up to date about new releases, monthly online meetings, upcoming workshops, and trainings.
23+
24+
To subscribe, send an email to
25+
`sympa@listserv.dfn.de <mailto:sympa@listserv.dfn.de?subject=subscribe%20esmvaltool>`_
26+
with the following subject line:
27+
28+
- *subscribe esmvaltool*
29+
30+
or
31+
32+
- *subscribe esmvaltool YOUR_FIRSTNAME YOUR_LASTNAME*
33+
34+
The mailing list also has a `public archive <https://www.listserv.dfn.de/sympa/arc/esmvaltool>`_ online.
35+
36+
.. _monthly-meetings:
37+
38+
Monthly meetings
39+
----------------
40+
41+
We have monthly online meetings using `zoom <https://zoom.us/>`__, anyone with
42+
an interest in the ESMValTool is welcome to join these meetings to connect with
43+
the community.
44+
These meetings are always announced in a discussion
45+
on the `ESMValTool Community <https://github.com/ESMValGroup/Community/discussions>`_
46+
repository and on the mailing-list_.
47+
48+
.. _core-team:
49+
50+
Development team
51+
----------------
52+
53+
ESMValTool is developed by a community of scientists and research software
54+
engineers from multiple institutes. An overview of the team is available
55+
on the `development team page <https://esmvaltool.org/team/>`__.
56+
57+
Recipes and diagnostics
58+
-----------------------
59+
60+
Contacts for specific diagnostic sets are the respective authors, as
61+
listed in the corresponding :ref:`recipe and diagnostic documentation<recipes>`
62+
and in the source code.

‎doc/sphinx/source/tutorials/index.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Tutorials
2+
=========
3+
4+
A tutorial is available on https://tutorial.esmvaltool.org.
5+
6+
Learning resources
7+
------------------
8+
9+
A series of video lectures has been created by `ACCESS-NRI <https://www.access-nri.org.au>`_.
10+
While these are tailored for ACCESS users, they are still very informative.
11+
12+
.. raw:: html
13+
14+
<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=pUXrXB8C8bLRfQHY&amp;list=PLFjfi2xLaFpJp59LvDc1upQsj_xzFlFLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

0 commit comments

Comments
 (0)