Skip to content

docs: link yMMSL configuration reference - #384

Open
ColumbusLabs wants to merge 2 commits into
multiscale:developfrom
ColumbusLabs:codex/link-ymmsl-documentation
Open

docs: link yMMSL configuration reference#384
ColumbusLabs wants to merge 2 commits into
multiscale:developfrom
ColumbusLabs:codex/link-ymmsl-documentation

Conversation

@ColumbusLabs

Copy link
Copy Markdown

Closes #190.

Add the live stable yMMSL documentation as a labeled external entry in MUSCLE3’s API documentation navigation, making its configuration examples and Python API reference directly discoverable.

Validation:

  • live target returns HTTP 200 and matches the existing yMMSL intersphinx base
  • external Title toctree syntax passes an isolated Sphinx 8 build with warnings as errors
  • git diff --check

The full repository docs build reaches the existing Doxygen prerequisite and stops because doxygen/json-glib are not installed locally; the changed navigation entry was validated independently.

@carschno

carschno commented Jul 27, 2026

Copy link
Copy Markdown

Hi @ColumbusLabs,
(rephrasing my previous comment)
your contribution to this project is very welcome! We have been wondering about your motivation, and the role of AI in this, for reasons of transparency.

@LourensVeen LourensVeen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, and it works, which is always nice 😄. I think the examples and explanation is probably more important than the ymmsl API though, the latter isn't used much by end users, only by tool developers. So I'd prefer to have the link after models_as_software, and maybe just call it "yMMSL documentation"?

@LourensVeen

Copy link
Copy Markdown
Contributor

Or maybe you've contributed to MUSCLE3 before, under a different account?

This project seems to be completely unrelated to anything else Columbus Labs does, so I'm a bit confused too, but always happy to take contributions 😄. I have added a small request in my review.

@ColumbusLabs
ColumbusLabs force-pushed the codex/link-ymmsl-documentation branch from 10a505b to ea96615 Compare July 28, 2026 23:59
@ColumbusLabs

Copy link
Copy Markdown
Author

Thanks, agreed. I moved the link into the main Contents section immediately after models_as_software and shortened the label to “yMMSL documentation” in ea96615.

@ColumbusLabs

Copy link
Copy Markdown
Author

This is my first MUSCLE3 contribution, and I have not contributed under another account. Columbus Labs is working through public open-source issues, and I chose #190 because it was a clearly scoped documentation gap. I used an AI coding assistant to help inspect the repository, make the change, and run the checks; I reviewed the documentation change and validation before submitting.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make ymmsl documentation easier to find

3 participants