Hello, I'm one of the main contributors to Godot's documentation. I'm looking at developing a Sphinx extension to make a documentation page switchable between snake_case and PascalCase syntax for method references (which are links) and *inline* code. (We've already got multiline code samples covered by the sphinx-tabs extension.) See this issue on the godot-docs repository: https://github.com/godotengine/godot-docs/issues/828
For example, I have a page like this: https://docs.godotengine.org/en/stable/classes/class_node.html I want to add a button on the page that switches between snake_case (GDScript) and PascalCase (C#) syntax for all methods/properties on the page. I've looked at writing a Sphinx extension, but I don't know if you can expose new "inline blocks" like :ref: or :kbd: which are built-in. For inline code samples, we currently do this: To enable processing, call the ``set_process(true)`` method. I'd imagine we would have to create a custom syntax like this (GDScript on the left, C# on the right): To enable processing, call the :code:`set_process(true);;SetProcess(true)` method. (The double semicolon separator is just an example, but we need to use something we'll never use for other purposes in inline code samples.) As for method references, we currently use this: :ref:`_physics_process<class_Node_method__physics_process>` For this case, I think it would be enough to use a custom inline block that behaves like :ref:, but tells the JavaScript side that the syntax should be switched depending on the user preference: :coderef:`_physics_process<class_Node_method__physics_process>` I don't think we can run the syntax-switching logic on every link in the page, as there would be many false positives. The same goes for inline code, since parts of the Godot API are always snake_case, even when using C#. As for the syntax switching itself, it will be done using JavaScript code (which I can write myself). Therefore, my question is only about being able to clearly identify the text whose syntax must be changed. Thanks in advance for answering :) Hugo Locurcio -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/026123c5-7128-4f88-bb7d-f9c28205b6ean%40googlegroups.com.
