Skip to content

Commit

Permalink
refactor(docs): add ORCID icon and link to authors (#1606)
Browse files Browse the repository at this point in the history
  • Loading branch information
mwtoews committed Oct 27, 2022
1 parent 2f71612 commit 66a28c5
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 26 deletions.
Binary file added .docs/_images/orcid_16x16.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 11 additions & 1 deletion .docs/conf.py
Expand Up @@ -68,11 +68,21 @@
"post-processing. Members of the team\n"
"currently include:\n\n"
)
image_directives = ""
orcid_image = "_images/orcid_16x16.png"
parts = ["given-names", "name-particle", "family-names", "name"]
for author in citation["authors"]:
name = " ".join([author[pt] for pt in parts if pt in author])
line += f" * {name}\n"
line += f" * {name}"
if "orcid" in author:
tag = "orcid_" + name.replace(" ", "_").replace(".", "")
line += f" |{tag}|"
image_directives += f".. |{tag}| image:: {orcid_image}\n"
image_directives += f" :target: {author['orcid']}\n"
line += "\n"
line += " * and others\n\n"
line += image_directives
line += "\n"
f.write(line)
elif line.startswith(tag_end):
write_line = True
Expand Down
53 changes: 40 additions & 13 deletions .docs/introduction.rst
Expand Up @@ -85,22 +85,49 @@ FloPy is developed by a team of MODFLOW users that have switched over to using
Python for model development and post-processing. Members of the team
currently include:

* Mark Bakker
* Vincent Post
* Joseph D. Hughes
* Christian D. Langevin
* Jeremy T. White
* Andrew T. Leaf
* Scott R. Paulinski
* Jason C. Bellino
* Eric D. Morway
* Michael W. Toews
* Joshua D. Larsen
* Michael N. Fienen
* Jon Jeffrey Starn
* Mark Bakker |orcid_Mark_Bakker|
* Vincent Post |orcid_Vincent_Post|
* Joseph D. Hughes |orcid_Joseph_D_Hughes|
* Christian D. Langevin |orcid_Christian_D_Langevin|
* Jeremy T. White |orcid_Jeremy_T_White|
* Andrew T. Leaf |orcid_Andrew_T_Leaf|
* Scott R. Paulinski |orcid_Scott_R_Paulinski|
* Jason C. Bellino |orcid_Jason_C_Bellino|
* Eric D. Morway |orcid_Eric_D_Morway|
* Michael W. Toews |orcid_Michael_W_Toews|
* Joshua D. Larsen |orcid_Joshua_D_Larsen|
* Michael N. Fienen |orcid_Michael_N_Fienen|
* Jon Jeffrey Starn |orcid_Jon_Jeffrey_Starn|
* Davíd Brakenhoff
* and others

.. |orcid_Mark_Bakker| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0002-5629-2861
.. |orcid_Vincent_Post| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0002-9463-3081
.. |orcid_Joseph_D_Hughes| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0003-1311-2354
.. |orcid_Christian_D_Langevin| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0001-5610-9759
.. |orcid_Jeremy_T_White| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0002-4950-1469
.. |orcid_Andrew_T_Leaf| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0001-8784-4924
.. |orcid_Scott_R_Paulinski| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0001-6548-8164
.. |orcid_Jason_C_Bellino| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0001-9046-9344
.. |orcid_Eric_D_Morway| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0002-8553-6140
.. |orcid_Michael_W_Toews| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0003-3657-7963
.. |orcid_Joshua_D_Larsen| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0002-1218-800X
.. |orcid_Michael_N_Fienen| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0002-7756-4651
.. |orcid_Jon_Jeffrey_Starn| image:: _images/orcid_16x16.png
:target: https://orcid.org/0000-0001-5909-0010

How to Cite
===========

Expand Down
13 changes: 1 addition & 12 deletions .docs/tutorials.rst
Expand Up @@ -28,6 +28,7 @@ Contents:
_notebooks/tutorial06_mf6_data
_notebooks/tutorial07_mf6_data
_notebooks/tutorial08_mf6_data
_notebooks/tutorial09_mf6_data


MODFLOW 6 Output Tutorials
Expand All @@ -53,18 +54,6 @@ Contents:
_notebooks/tutorial02_mf


.IPYNB_CHECKPOINTS Tutorials
----------------------------

Contents:

.. toctree::
:maxdepth: 2

_notebooks/tutorial01_mf-checkpoint
_notebooks/tutorial02_mf-checkpoint


SEAWAT Tutorials
----------------

Expand Down

0 comments on commit 66a28c5

Please sign in to comment.