[DRAFT] Migrate to the new intersphinx reference syntax

[amotl]

About

We just learned about the new intersphinx syntax from the article Migrating to the New Intersphinx Reference Syntax by @jdillard. Thanks a stack! 💯

Preview

Visually, nothing changed.
https://cratedb-guide--503.org.readthedocs.build/solution/time-series/learn/normalize-pandas.html

Thoughts

• The article excellently provides regular expressions for finding corresponding references in reStructuredText. For our purposes, we need the same for MyST Markdown, to identify references like

  {ref}`crate-python:index`
  

• Could there be a tool to support the conversion, for both reStructuredText and MyST Markdown? Maybe a tool exists already?

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch intersphinx-reference-syntax-ng

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[jdillard]

Glad it was helpful! I was starting to think nobody was going to find that article 😆

If you come up with some MyST regexes I'd be happy to update the article and give credit.

I also created jdillard/sphinx-cmd#21 for the tool. I probably can't get to it right away, but I think it would be a great enhancement.

[amotl]

Hi Jared,

thanks for your swift reply, and thanks for already carrying this forward into a dedicated ticket. I am also low on time right now, but that doesn't mean I will never submit a patch to sphinx-cmd if I am lucky ;].

When continuing to work on this patch, I will start crafting a regular expression first, and will let you know about updating the article. Thank you again, and keep up the spririt.

Glad the article was helpful! I was starting to think nobody was going to find that article 😆

Absolutely helpful, I can't imagine how else this information could have reached me, and apparently it's already present as a fact since Sphinx 4.4? omg!

NB: I agree it's incredibly harder to find content of quality on the web today, or let it find you, because all that LLM yapping up and down. Well, c'est la vie, maybe the community will get over it, maybe not. In this spirit, never stop publishing. 🙏