Creation of ION Functions Documentation Pages

[cwingard]

All here is the first draft of documentation for the ION Functions library. I've updated the doc strings in:

ctd_functions.py
flo_functions.py
co2_functions.py
ph_functions.py
phsen_h_functions.py
hyd_functions.py

using the existing DPS documentation to help further extend the documentation pages. You can see the results of the new documentation in my account: https://cwingard.github.io/ion-functions/. This is very much a work in progress and I am hoping to get feedback from folks as to the overall look and feel, direction and any suggested edits and tweaks.

The plan is to work through the code in batches over the course of the summer, with everything converted over and ready to merge into the master branch at that time. An additional goal is to create PyPi and conda-forge packages from the code that can be versioned (which can also be used to version the documentation).

Please do not merge this PR; I'll take care of that. Rather use this interface to provide feedback.

[jfram]

Chris, Maybe add links to the current DPS files these will be replacing so one can easily side-by-side compare. Thanks, -Jon

…

________________________________ From: Christopher Wingard ***@***.***> Sent: Friday, May 1, 2026 4:04 PM To: oceanobservatories/ion-functions ***@***.***> Cc: Fram, Jonathan ***@***.***>; Review requested ***@***.***> Subject: [oceanobservatories/ion-functions] Creation of ION Functions Documentation Pages (PR #44) [This email originated from outside of OSU. Use caution with links and attachments.] All here is the first draft of documentation for the ION Functions library. I've updated the doc strings in: ctd_functions.py flo_functions.py co2_functions.py ph_functions.py phsen_h_functions.py hyd_functions.py using the existing DPS documentation to help further extend the documentation pages. You can see the results of the new documentation in my account: https://cwingard.github.io/ion-functions/. This is very much a work in progress and I am hoping to get feedback from folks as to the overall look and feel, direction and any suggested edits and tweaks. The plan is to work through the code in batches over the course of the summer, with everything converted over and ready to merge into the master branch at that time. An additional goal is to create PyPi and conda-forge packages from the code that can be versioned (which can also be used to version the documentation). Please do not merge this PR; I'll take care of that. Rather use this interface to provide feedback.

________________________________ You can view, comment on, or merge this pull request online at: #44 Commit Summary * 1832838<1832838> Add MkDocs infrastructure and project documentation guide * 2ef7a6d<2ef7a6d> Converting the CTD functions and creating the documentation page * 12a6f89<12a6f89> Converting the FLO functions and creating the documentation page * 3d4c035<3d4c035> Converting the HYD functions and creating the documentation page * c2458f9<c2458f9> Update the navigation structure * 9b86c3a<9b86c3a> Adding MathJax support * a136376<a136376> Converting the pH and pCO2 functions and creating the documentation * 31e74f9<31e74f9> Final updates before external reviews * e64af30<e64af30> Working through edits File Changes (24 files<https://github.com/oceanobservatories/ion-functions/pull/44/files>) * A .github/workflows/docs-preview.yml<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-b2dfe4aeecdb9075a7cc1eb9e254ffdd4c35485caefa7aea80e4895c0f379918> (34) * A .github/workflows/docs.yml<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-9cf2000c53760d837a449f874e53f792819108d3a4bf346336d0f7d082deae2c> (30) * M .gitignore<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947> (39) * M README.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5> (159) * M conda_env.yml<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-d1c7ff7bd8f51ae656444ed5e3194f228af2a56e3a202de5c2556bd0ea13e6f1> (26) * A docs/api/co2_functions.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-a7a09a03a774708f75dc653f84c983fcc83f5d495723ab4c9c3e1cd1909483d8> (349) * A docs/api/ctd_functions.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-2b05596e7d52b89c20df69dfd4ac4be4801f80221d8a5902e03970d9a39622b9> (482) * A docs/api/flo_functions.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-23d88979c2285d2fcdb81d455365889e605e77e4d22561ace5ffe6572ee3e49b> (311) * A docs/api/hyd_functions.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-6577fb6d9753776db7471760a91dc70ad4f3e9886f1fe4951ef3e81c2e3d772c> (141) * A docs/api/ph_functions.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-5dc93b480c25f57095da9002521c3807c95019a748cecc6cf7c2b5c644381253> (405) * A docs/assets/NSF-OOI-RGB.png<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-79c183777415cc44a191dd3494fbfe8809562e1db4c2dab370b7c93db38d5e08> (0) * A docs/assets/custom.css<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-e02ba901631a4f209e338cb17ce0f057548bff38033bf645ed50755101da04f1> (67) * A docs/assets/mathjax.js<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-087bcc9bd5703750b8a207c94ff1d27682e0c99784abb6ed6eaa65180af8c186> (13) * A docs/calibrations.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-2c409d62ba02fa3f8a361e20609083f2a5be2cfcb75ccf7b0c6a8d17725e090f> (8) * A docs/function_types.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-9f6987877ad9423e86b866a21df3abea17b8392cfb68cf61a0a081bd8c7b8a6c> (52) * A docs/index.md<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6> (45) * M ion_functions/data/co2_functions.py<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-df3ca6b6a533c981e157d451225de9b6315d6fcaebfb29ad15aced7dee3668f5> (641) * M ion_functions/data/ctd_functions.py<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-77aaa0f6bf49609723da5972bf1ee820e9baaa33bae4fdf32eb217930cb7950e> (1071) * M ion_functions/data/flo_functions.py<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-9166d1e36c584f96db55c2a16ea17132344e94de906eb4607f3f1c35c5578d46> (586) * M ion_functions/data/hyd_functions.py<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-fac63c96e67813c9b66a1fecb6ef982b67105e0a364c668d1d8b990a9fcbcaac> (122) * M ion_functions/data/ph_functions.py<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-9d0270aab415c4fcf5dba44db43024b3bafb5f40cdf06c9e6a4e4f031f7cf29b> (242) * M ion_functions/data/phsen_h_functions.py<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-f70e236080b60b4e38a21ad7588a49258cda78cfecd9136b97f51bc230ff032e> (591) * A mkdocs.yml<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2> (50) * M requirements.txt<https://github.com/oceanobservatories/ion-functions/pull/44/files#diff-4d7c51b1efe9043e44439a949dfd92e5827321b34082903477fd04876edb7552> (2) Patch Links: * https://github.com/oceanobservatories/ion-functions/pull/44.patch * https://github.com/oceanobservatories/ion-functions/pull/44.diff — Reply to this email directly, view it on GitHub<#44>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKLWPDAAHDDAJSUTA4GE6WT4YUUOTAVCNFSM6AAAAACYN4RPZGVHI2DSMVQWIX3LMV43ASLTON2WKOZUGM3DOMBUGIYTGMA>. Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because your review was requested.Message ID: ***@***.***>

[cwingard]

@jfram The DPS documents are listed in the References section for each page (and linked). Are you suggesting they be moved up higher into a separate section? Make them more visible?

[wruef]

Nicely laid out, the functions are cleaner and more readable, and the wiki is very nice.

Noting that calibrations.md is still a placeholder, every looks good to me.

[mvardaro]

I really like this. It can be a little hard to distinguish between the "background" and "core functions" sections in the wiki pages, but the ToC on the left helps a lot. References seem clear, and I think it's fine to keep them at the end, but maybe there can be a pointer within the "Background" section to let users know where the info originates. Anyway, this is a good start and I like the approach.