Fix documentation build

Author: taminomara

docs/source/autodoc.rst

@@ -16,10 +16,10 @@ can be slightly different:
       comments.
 
       When generating documentation for a module, Sphinx-LuaLs will include
-      all module's objects returned by `require`, as well as all types located
+      all module's objects returned by ``require``, as well as all types located
       in the same namespace.
 
-      That is, for module `meow`, it will list everything in the ``require("meow")``,
+      That is, for module ``meow``, it will list everything in the ``require("meow")``,
       as well as all classes, aliases, and enums that have prefix ``meow.*``.
 
       Thus, a typical Lua module will look like this:
@@ -185,7 +185,7 @@ Autodoc directive
    .. rst:directive:option:: undoc-members
 
       Include undocumented members to the object's description. By default,
-      they are skipped even if :rst:dir:`members` is passed.
+      they are skipped even if :rst:dir:`members <lua:autoobject:members>` is passed.
 
       Accepts a comma-separated list of names; if list is empty,
       adds all undoc members.

docs/source/conf.py

@@ -12,6 +12,7 @@
 
 extensions = [
     "sphinx.ext.githubpages",
+    "sphinx.ext.intersphinx",
     "sphinx_design",
     "sphinx_lua_ls",
     "myst_parser",
@@ -23,9 +24,14 @@
 primary_domain = "lua"
 default_role = "lua:obj"
 
-lua_ls_project_root = "../example"
+lua_ls_project_root = "example"
 lua_ls_backend = "emmylua"
 
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "sphinx": ("https://www.sphinx-doc.org/", None),
+}
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

docs/source/settings.rst

@@ -89,14 +89,14 @@ Settings
 .. py:data:: class_default_force_non_colon
    :type:
 
-   If `true`, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
+   If ``True``, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
 
    If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
 
 .. py:data:: class_default_force_return_self
    :type:
 
-   If `true`, Sphinx-LuaLs will replace class constructor's return type with ``self``.
+   If ``True``, Sphinx-LuaLs will replace class constructor's return type with ``self``.
 
    If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
 
@@ -109,7 +109,7 @@ Settings
    Can be either ``"5.1"``, ``"5.2"``, ``"5.3"``, ``"5.4"``, or ``"jit"``.
 
    By default, Sphinx-LuaLs will choose this setting
-   based on your `.emmyrc.json`/`.luarc.json` file.
+   based on your ``.emmyrc.json``/``.luarc.json`` file.
 
 .. py:data:: lua_ls_apidoc_roots
    :type: dict[str, str | dict[str, Any]]
@@ -165,7 +165,7 @@ Settings
       This option might not work correctly on case-insensitive file systems.
 
       It will generate a separate file for every member of a module;
-      if there are members that only differ in case (i.e. `Class` vs `class`),
+      if there are members that only differ in case (i.e. ``Class`` vs ``class``),
       one of them will overwrite the file for another.
 
       If you're on Windows, and you experience difficulties because of it,
@@ -215,7 +215,7 @@ Settings
 
    Default value is ``50``, which is suitable for most Sphinx themes.
 
-   Setting this value to `None` will cause signature formatter
+   Setting this value to ``None`` will cause signature formatter
    to use Sphinx's global setting ``maximum_signature_line_length``.
    If ``maximum_signature_line_length`` is also ``None``,
    signature wrapping will be disabled.