Skip to content

Add new documentation on how to create custom supplements libraries.#9029

Open
joa-quim wants to merge 2 commits into
masterfrom
new-custom-supp-templates
Open

Add new documentation on how to create custom supplements libraries.#9029
joa-quim wants to merge 2 commits into
masterfrom
new-custom-supp-templates

Conversation

@joa-quim
Copy link
Copy Markdown
Member

New devdocs page (doc/rst/source/devdocs/custom_supplements.rst) explaining the in-tree vs out-of-tree supplement build mechanism: the five-symbol GMT_MODULEINFO contract, how src/CMakeLists.txt auto-generates the glue and module info header for in-tree supps (windbarbs as reference), and what an out-of-tree project must vendor to reproduce the same wiring.

This work was applied into (re)building the MB-system modules lib such that they show up when doing 'gmt --show-modules' and some more worked test examples let be called from Julia and exchange memory data (like the whole GMT).

We have old documentation on this in other repositories but I frankly find it impossible to understand.

New devdocs page (doc/rst/source/devdocs/custom_supplements.rst) explaining the in-tree vs out-of-tree supplement build mechanism: the five-symbol GMT_MODULEINFO contract, how src/CMakeLists.txt auto-generates the glue and moduleinfo header for in-tree supps (windbarbs as reference), and what an out-of-tree project must vendor to reproduce the same wiring.

This work was applied into (re)building the MB-system modules lib such that they show up when doing 'gmt --show-modules' and some more worked test examples let be called from Julia and exchange memory data (like the whole GMT).
@joa-quim joa-quim requested a review from a team May 21, 2026 23:09
@Esteban82 Esteban82 added the documentation Improve documentation label May 22, 2026
Copy link
Copy Markdown
Member

@Esteban82 Esteban82 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine. But I am not sure about its content.

@joa-quim
Copy link
Copy Markdown
Member Author

It is the basis of this MB PR #9029

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improve documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants