mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
95fb178429
This allows users to leave comments on pages that don't have `:allow_comments: False` somewhere in the page's source. Both manual and class reference pages can receive comments. Index pages cannot have comments, as discussion should occur on "leaf" pages. GitHub Discussions is used as a backend on the same repository. This means that Discussions *must* be enabled on godotengine/godot-docs before this commit is merged to `master`. Users can choose to use the "Custom" watch mode if they don't want to get notifications for discussion updates, but still get notifications for issue and pull request updates. User comments are intended to be used for the following purposes: - Add a clarification or correct something in the documentation, without having to open a pull request. Contributors are encouraged to take a look at discussions from time to time, and see if there's information worth incorporating in the pages themselves. Don't forget to reply to the comment when doing so :) - Mention a workaround for a common issue. - Link to useful third-party resources that are relevant to the current page, such as tutorials or add-ons. User comments should *not* be used for technical support. Other community platforms should be used for that. Page-to-discussion matching is done using the `pagename` Sphinx variable, which is independent of the Godot version and documentation language. Being independent of the Godot version allows keeping old comments when the Godot version changes, while also allowing users from `/stable` and `/4.1` to "see" each other in discussions. See https://giscus.app for more information.
42 lines
1.2 KiB
ReStructuredText
42 lines
1.2 KiB
ReStructuredText
:allow_comments: False
|
|
|
|
.. _doc_configuring_an_ide:
|
|
|
|
Configuring an IDE
|
|
==================
|
|
|
|
We assume that you have already `cloned <https://github.com/godotengine/godot>`_
|
|
and :ref:`compiled <toc-devel-compiling>` Godot.
|
|
|
|
You can easily develop Godot with any text editor and by invoking ``scons``
|
|
on the command line, but if you want to work with an IDE (Integrated
|
|
Development Environment), here are setup instructions for some popular ones:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: toc-devel-configuring_an_ide
|
|
|
|
android_studio
|
|
clion
|
|
code_blocks
|
|
kdevelop
|
|
qt_creator
|
|
rider
|
|
visual_studio
|
|
visual_studio_code
|
|
xcode
|
|
|
|
It is possible to use other IDEs, but their setup is not documented yet.
|
|
|
|
If your editor supports the `language server protocol <https://microsoft.github.io/language-server-protocol/>`__,
|
|
you can use `clangd <https://clangd.llvm.org>`__ for completion, diagnostics, and more.
|
|
You can generate a compilation database for use with clangd one of two ways:
|
|
|
|
.. code-block:: shell
|
|
|
|
# Generate compile_commands.json while compiling
|
|
scons compiledb=yes
|
|
|
|
# Generate compile_commands.json without compiling
|
|
scons compiledb=yes compile_commands.json
|