-
Notifications
You must be signed in to change notification settings - Fork 224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add development toctree and PyGMT team page #1308
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if it helps, but you can actually write a markdown document instead, since we have the MyST parser. Might be less painful than writing pure HTML or RST.
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. |
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. |
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. |
Co-authored-by: Dongdong Tian <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Co-authored-by: Wei Ji <[email protected]>
Anyone have ideas for why the style checks are failing? I did not touch those files, and the checks pass locally. |
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. |
thanks, sounds good. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new design looks good to me. Besides a possible typo, should we use markdown instead of ReStructureText for this file, since we now use the MyST parser and some other files (contributing, maintaining) are also markdown files?
Co-authored-by: Dongdong Tian <[email protected]>
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. |
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. |
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. |
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 <[email protected]> Co-authored-by: Wei Ji <[email protected]>
Description of proposed changes
This PR adds a PyGMT team page under a development toctree in the docs.
Fixes #1212
Reminders
make format
andmake check
to 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