Skip to content
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

Merged
merged 31 commits into from
Jul 8, 2021
Merged

Add development toctree and PyGMT team page #1308

merged 31 commits into from
Jul 8, 2021

Conversation

maxrjones
Copy link
Member

@maxrjones maxrjones commented May 28, 2021

Description of proposed changes

This PR adds a PyGMT team page under a development toctree in the docs.

Fixes #1212

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@maxrjones maxrjones marked this pull request as draft May 28, 2021 20:47
Copy link
Member

@weiji14 weiji14 left a 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.

@maxrjones
Copy link
Member Author

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.

@core-man
Copy link
Member

core-man commented May 29, 2021

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
Copy link
Member Author

Numpy: About us lists the Numpy: Team gallery. See the corresponding markdown files:

* [numpy.org/conent/en/about.md](https://github.com/numpy/numpy.org/blob/master/content/en/about.md)

* [numpy.org/scripts/gallery](https://github.com/numpy/numpy.org/tree/master/scripts/gallery)

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.

@michaelgrund
Copy link
Member

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.

doc/_static/style.css Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <[email protected]>
Copy link
Member

@weiji14 weiji14 left a 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.

doc/team.rst Outdated Show resolved Hide resolved
doc/team.rst Outdated Show resolved Hide resolved
@weiji14 weiji14 added the documentation Improvements or additions to documentation label May 31, 2021
doc/team.rst Outdated Show resolved Hide resolved
doc/team.rst Outdated Show resolved Hide resolved
@maxrjones
Copy link
Member Author

Anyone have ideas for why the style checks are failing? I did not touch those files, and the checks pass locally.

@seisman
Copy link
Member

seisman 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.

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
Copy link
Member Author

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.

Copy link
Member

@seisman seisman left a 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?

doc/team.rst Outdated Show resolved Hide resolved
@seisman seisman added this to the 0.5.0 milestone Jul 1, 2021
Co-authored-by: Dongdong Tian <[email protected]>
@maxrjones
Copy link
Member Author

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?

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
Copy link
Member

core-man commented Jul 2, 2021

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?

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
Copy link
Member

seisman commented Jul 2, 2021

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?

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.

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
Copy link
Member Author

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?

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.

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.

@maxrjones maxrjones merged commit 11c1301 into master Jul 8, 2021
@maxrjones maxrjones deleted the pygmt-team branch July 8, 2021 22:54
@seisman seisman modified the milestones: 0.5.0, 0.4.1 Jul 25, 2021
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 4, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding a PyGMT team page
5 participants