Skip to content

Commit d7a39e4

Browse files
tacaswelltacaswell
authored
Merge pull request #16065 from timhoffm/doc-index-community
DOC: Nicer formatting of community aspects on front page
2 parents 602d2ca + 640bed0 commit d7a39e4

11 files changed

+117
-39
lines changed

‎doc/_static/fa/LICENSE

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Font Awsome SVG Icons are covered by CC BY 4.0 License.
2+
3+
https://fontawesome.com/license/free
4+
5+
Icons are based on Font Awesome 5.11.2 and colors have been adapted.

‎doc/_static/fa/discourse-brands.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/envelope-regular.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/github-brands.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/gitter-brands.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/hashtag-solid.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/plus-square-regular.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/question-circle-regular.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/fa/stack-overflow-brands.svg

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/mpl.css

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1051,7 +1051,7 @@ div.responsive_subfig img {
10511051
width: 100%;
10521052
}
10531053

1054-
@media only screen and (max-width: 1000px){
1054+
@media only screen and (max-width: 930px){
10551055
/* The value of 1000px was handcrafted to provide a more or less */
10561056
/* smooth transition between the 1x4 and the 2x2 layouts. It is */
10571057
/* NB: it is slightly below 1024px: so one should still have a */
@@ -1180,3 +1180,41 @@ nav.main-nav{
11801180
padding: 3px 6px;
11811181
width: 198px;
11821182
}
1183+
1184+
/* community items on main page */
1185+
div.box {
1186+
display: flex;
1187+
flex-flow: row wrap;
1188+
}
1189+
1190+
div.box-item {
1191+
flex: 0 0 45%;
1192+
padding: 4px;
1193+
margin: 8px 12px;
1194+
}
1195+
1196+
div.box-item img {
1197+
float: left;
1198+
width: 30px;
1199+
height: 30px;
1200+
fill: #888;
1201+
1202+
}
1203+
div.box-item p {
1204+
margin: 0 0 0 50px;
1205+
}
1206+
1207+
div.box-item ul {
1208+
margin: 0 0 0 50px;
1209+
padding-left: 20px;
1210+
}
1211+
1212+
hr.box-sep {
1213+
margin: 1em 2em;
1214+
}
1215+
1216+
@media only screen and (max-width: 930px){
1217+
div.box-item {
1218+
flex: 0 0 90%;
1219+
}
1220+
}

‎doc/index.rst

Lines changed: 65 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -112,37 +112,71 @@ Software Foundation Code of Conduct <coc_>`_ in everything we do.
112112

113113
.. _coc: http://www.python.org/psf/codeofconduct/
114114

115-
- Join our community at `discourse.matplotlib.org`_ to get help, discuss
116-
contributing & development, and share your work.
117-
- If you have questions, be sure to check the :doc:`FAQ <faq/index>`, the
118-
:doc:`API <api/index>` docs, and the `search <search.html>`_ tool
119-
searches all of the documentation, including full text search of over 350
120-
complete examples which exercise almost every corner of Matplotlib.
121-
- If its something quick join the `gitter channel`_ to chat with the
122-
community.
123-
- If you prefer email there are the matplotlib-users_, matplotlib-devel_,
124-
and matplotlib-announce_ mailing lists.
125-
- Check out the Matplotlib tag on stackoverflow_.
126-
- Tweet us at Twitter_! or see cool plots on Instagram_!
127-
128-
.. _discourse.matplotlib.org: https://discourse.matplotlib.org
129-
.. _gitter channel: https://gitter.im/matplotlib/matplotlib
130-
.. _matplotlib-users: https://mail.python.org/mailman/listinfo/matplotlib-users
131-
.. _matplotlib-devel: https://mail.python.org/mailman/listinfo/matplotlib-devel
132-
.. _matplotlib-announce: https://mail.python.org/mailman/listinfo/matplotlib-announce
133-
.. _stackoverflow: http://stackoverflow.com/questions/tagged/matplotlib
134-
.. _Twitter: https://twitter.com/matplotlib
135-
.. _Instagram: https://www.instagram.com/matplotart/
136-
137-
You can file bugs, patches and feature requests on the `issue tracker`_, but it
138-
is a good idea to ping us on Discourse_ as well.
139-
140-
.. _Discourse: https://discourse.matplotlib.org
141-
142-
To keep up to date with what's going on in Matplotlib, see the :doc:`what's
143-
new <users/whats_new>` page or browse the `source code`_. Anything that could
144-
require changes to your existing code is logged in the :doc:`API changes
145-
<api/api_changes>` file.
115+
116+
.. raw:: html
117+
118+
<h3>Get help</h3>
119+
<div class="box">
120+
<div class="box-item">
121+
<img src="_static/fa/discourse-brands.svg" alt="Discourse">
122+
<p>Join our community at <a href="https://discourse.matplotlib.org">discourse.matplotlib.org</a>
123+
to get help, discuss contributing &amp; development, and share your work.</p>
124+
</div>
125+
<div class="box-item">
126+
<img src="_static/fa/question-circle-regular.svg" alt="Questions">
127+
<p>If you have questions, be sure to check the <a href="faq/index.html">FAQ</a>,
128+
the <a href="api/index.html">API</a> docs. The full text
129+
<a href="search.html">search</a> is a good way to discover the docs including the many examples.</p>
130+
</div>
131+
<div class="box-item">
132+
<img src="_static/fa/stack-overflow-brands.svg" alt="Stackoverflow">
133+
<p>Check out the Matplotlib tag on <a href="http://stackoverflow.com/questions/tagged/matplotlib">stackoverflow</a>.</p>
134+
</div>
135+
<div class="box-item">
136+
<img src="_static/fa/gitter-brands.svg" alt="Gitter">
137+
<p>Short questions may be posted on the <a href="https://gitter.im/matplotlib/matplotlib">gitter channel</a>.</p>
138+
</div>
139+
</div>
140+
<hr class='box-sep'>
141+
<h3>News</h3>
142+
<div class="box">
143+
<div class="box-item">
144+
<img src="_static/fa/plus-square-regular.svg" alt="News">
145+
<p>To keep up to date with what's going on in Matplotlib, see the
146+
<a href="users/whats_new.html">what's new</a> page or browse the
147+
<a href="https://github.com/matplotlib/matplotlib">source code</a>. Anything that could
148+
require changes to your existing code is logged in the
149+
<a href="api/api_changes.html">API changes</a> file.</p>
150+
</div>
151+
<div class="box-item">
152+
<img src="_static/fa/hashtag-solid.svg" alt="Social media">
153+
<p>Tweet us at <a href="https://twitter.com/matplotlib">Twitter</a>!
154+
or see cool plots on <a href="https://www.instagram.com/matplotart/">Instagram</a>!</p>
155+
</div>
156+
</div>
157+
<hr class='box-sep'>
158+
<h3>Development</h3>
159+
<div class="box">
160+
<div class="box-item">
161+
<img src="_static/fa/github-brands.svg" alt="Github">
162+
<p>Matplotlib is hosted on <a href="https://github.com/matplotlib/matplotlib">GitHub</a>.</p>
163+
<ul>
164+
<li>File bugs and feature requests on the <a href="https://github.com/matplotlib/matplotlib/issues">issue tracker</a>.</li>
165+
<li><a href="https://github.com/matplotlib/matplotlib/pulls">Pull requests</a> are always welcome.</li>
166+
</ul>
167+
<p>It is a good idea to ping us on <a href="https://discourse.matplotlib.org">Discourse</a> as well.</p>
168+
</div>
169+
<div class="box-item">
170+
<img src="_static/fa/envelope-regular.svg" alt="Mailing lists">
171+
<p>Mailing lists</p>
172+
<ul>
173+
<li><a href="https://mail.python.org/mailman/listinfo/matplotlib-users">matplotlib-users</a> for usage questions</li>
174+
<li><a href="https://mail.python.org/mailman/listinfo/matplotlib-devel">matplotlib-devel</a> for development</li>
175+
<li><a href="https://mail.python.org/mailman/listinfo/matplotlib-announce">matplotlib-announce</a> for project announcements</li>
176+
</ul>
177+
</div>
178+
</div>
179+
146180

147181
Toolkits
148182
========
@@ -214,10 +248,3 @@ Foundation (PSF) license <psf-license_>`_.
214248

215249
There is an active developer community and a long list of people who have made
216250
significant :doc:`contributions <users/credits>`.
217-
218-
Matplotlib is hosted on `GitHub <source code_>`_. `Issues <issue tracker_>`_
219-
and `Pull requests`_ are tracked at GitHub too.
220-
221-
.. _source code: https://github.com/matplotlib/matplotlib
222-
.. _issue tracker: https://github.com/matplotlib/matplotlib/issues
223-
.. _pull requests: https://github.com/matplotlib/matplotlib/pulls

0 commit comments

Comments
 (0)