Uh oh!
There was an error while loading. Please reload this page.
Add development toctree and PyGMT team page - #1308
Conversation
maxrjones
commented
May 28, 2021
Do you think pure HTML will be too hard to maintain? I did not find it too hard to write, but can research other options if necessary. I did not know of a way to create this format in markdown. |
Numpy: About us lists the Numpy: Team gallery. See the corresponding markdown files: It seems that it's a little easier to create a simple gallery using HTML than markdown at the beginning. |
maxrjones
commented
May 29, 2021
Thanks for sharing this - it's helpful to know how that page was built. I agree that it seems more complicated than raw html for now, since it requires several different files. |
michaelgrund
commented
May 29, 2021
I really like the HTML version (especially the pics look nice in that large format). On the other side, as the others mentioned, it should be also possible to easily maintain the whole thing. |
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
weiji14
left a comment
There was a problem hiding this comment.
I don't have the time to go down the rabbit hole of converting HTML to MyST/Markdown, so let's just stick with HTML.
I did consider all-contributors as an alternative before in GenericMappingTools/gmt#2330 (comment), but it's a bit more complex to configure and the PyGMT development team isn't quite at the size to warrant that yet.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
maxrjones
commented
Jun 30, 2021
Anyone have ideas for why the style checks are failing? I did not touch those files, and the checks pass locally. |
seisman
commented
Jun 30, 2021
pylint just released v2.9.1 a few hours ago (https://github.com/PyCQA/pylint/releases/tag/v2.9.1). The pylint errors are new and should be fixed in a separate PR. |
maxrjones
commented
Jun 30, 2021
thanks, sounds good. |
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
maxrjones
commented
Jul 2, 2021
I changed to markdown, even though I don't really understand the benefits of using MyST over traditional ReST with sphinx. Easy to revert if people don't like this change. |
core-man
commented
Jul 2, 2021
I feel it's okay to use ReST. Instead, shall we use ReSR for contributing and maintaining? We used Makrdown since they are original put in the repository. |
seisman
commented
Jul 2, 2021
See #941. The main reason to use the MyST is to avoid the pain of having to convert the markdown changelog generated by Release Drafter into ReST syntax (#885 (comment)). For other files (contributing or maintaining), using ReST or Markdown almost makes no difference, but I feel new contributors may be more familiar with Markdown syntax. |
maxrjones
commented
Jul 8, 2021
OK, I will leave as markdown and will merge in tomorrow unless anyone wants to veto with a thumbs down. |
Add PyGMT team page listing distinguished contributors with indicators for founders and active maintainers in a new development toctree. Move contributors and maintainers guides to the development toctree. Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Description of proposed changes
This PR adds a PyGMT team page under a development toctree in the docs.
Fixes#1212
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version