Separate high-level and low-level API in docs

GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.

https://www.pygmt.org

BSD 3-Clause "New" or "Revised" License

758 stars 220 forks source link

Separate high-level and low-level API in docs #254

Closed seisman closed 3 years ago

seisman commented 5 years ago

Description of the desired feature

Currently, all public APIs are listed on the same page (https://www.gmtpython.xyz/latest/api/index.html).

The "Exceptions" and "GMT C API" won't be used by most users. We probably should put these low-level APIs on a separate page.

Are you willing to help implement and maintain this feature? No

leouieda commented 5 years ago

I'm not sure we need a separate page for these. I put them at the bottom for this reason. But we'll see as the size of the API grows it might be better to do that. Keeping this open for reference.

weiji14 commented 3 years ago

The API page at https://www.pygmt.org/v0.3.0/api/index.html isn't very long yet (as of early 2021), so probably fine to close this issue for now. Feel free to reopen in the future.