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

Convert projection table from reStructuredText to Markdown #3363

Merged
merged 21 commits into from
Aug 2, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jul 30, 2024

Description of proposed changes

This PR tests / aims the conversion of the projection table from reStructuredText to Markdown (#3346 (comment), #3356 (comment)):

  • Substitution definitions
  • Sub / super scripts
  • URL links within PyGMT documentation
  • Readability: Line length, white spaces (and exception)
  • | exception

Preview:

Fixes #

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code

@weiji14 weiji14 changed the title POC / DARFT / WIP: Convert projection table from reStructuredText to Markdown POC / DRAFT / WIP: Convert projection table from reStructuredText to Markdown Jul 30, 2024
doc/conf.py Outdated Show resolved Hide resolved
doc/techref/projections.md Outdated Show resolved Hide resolved
doc/techref/projections.md Outdated Show resolved Hide resolved
@seisman seisman added the documentation Improvements or additions to documentation label Aug 1, 2024
@seisman seisman added this to the 0.13.0 milestone Aug 1, 2024
@seisman seisman mentioned this pull request Aug 1, 2024
39 tasks
@yvonnefroehlich yvonnefroehlich self-assigned this Aug 1, 2024
doc/techref/projections.md Outdated Show resolved Hide resolved
doc/techref/projections.md Outdated Show resolved Hide resolved
doc/techref/projections.md Outdated Show resolved Hide resolved
doc/techref/projections.md Outdated Show resolved Hide resolved
@yvonnefroehlich
Copy link
Member Author

/format

@seisman seisman changed the title POC / DRAFT / WIP: Convert projection table from reStructuredText to Markdown Convert projection table from reStructuredText to Markdown Aug 1, 2024
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Aug 1, 2024
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 2, 2024
@seisman seisman merged commit 053c5d8 into main Aug 2, 2024
9 checks passed
@seisman seisman deleted the convert-proj-table-rst2md branch August 2, 2024 04:14
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.

3 participants