doc: remove dune:stanza directive (#10219)

* remove dune:stanza uses Signed-off-by: Etienne Millon <me@emillon.org> * remove dunedomain Signed-off-by: Etienne Millon <me@emillon.org> --------- Signed-off-by: Etienne Millon <me@emillon.org>
ocaml · Mar 6, 2024 · 633256c · 633256c
1 parent 534f25f
commit 633256c
Show file tree

Hide file tree

Showing 22 changed files with 27 additions and 166 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -41,7 +41,6 @@
 # ones.
 extensions = [
     'sphinx_copybutton',
-    'sphinx_dunedomain',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/doc/exts/sphinx_dunedomain.py b/doc/exts/sphinx_dunedomain.py
diff --git a/doc/reference/files/dune-project/accept_alternative_dune_file_name.rst b/doc/reference/files/dune-project/accept_alternative_dune_file_name.rst
@@ -1,7 +1,7 @@
 accept_alternative_dune_file_name
 ---------------------------------
 
-.. dune:stanza:: accept_alternative_dune_file_name
+.. describe:: (accept_alternative_dune_file_name ...)
 
    .. versionadded:: 3.0
 

diff --git a/doc/reference/files/dune-project/cram.rst b/doc/reference/files/dune-project/cram.rst
@@ -1,8 +1,7 @@
 cram
 ----
 
-.. dune:stanza:: cram
-   :param: <status>
+.. describe:: (cram <status>)
 
    Define whether Cram-style tests are enabled for the project.
 

diff --git a/doc/reference/files/dune-project/dialect.rst b/doc/reference/files/dune-project/dialect.rst
@@ -1,7 +1,7 @@
 dialect
 -------
 
-.. dune:stanza:: dialect
+.. describe:: (dialect ...)
 
    Declare a new :term:`dialect`.
 

diff --git a/doc/reference/files/dune-project/executables_implicit_empty_intf.rst b/doc/reference/files/dune-project/executables_implicit_empty_intf.rst
@@ -1,7 +1,7 @@
 executables_implicit_empty_intf
 -------------------------------
 
-.. dune:stanza:: executables_implicit_empty_intf
+.. describe:: (executables_implicit_empty_intf ...)
 
    .. versionadded:: 2.9
 

diff --git a/doc/reference/files/dune-project/expand_aliases_in_sandbox.rst b/doc/reference/files/dune-project/expand_aliases_in_sandbox.rst
@@ -1,7 +1,7 @@
 expand_aliases_in_sandbox
 -------------------------
 
-.. dune:stanza:: expand_aliases_in_sandbox
+.. describe:: (expand_aliases_in_sandbox ...)
 
    When a sandboxed action depends on an alias, copy the expansion of the alias
    inside the sandbox. For instance, in the following example:

diff --git a/doc/reference/files/dune-project/explicit_js_mode.rst b/doc/reference/files/dune-project/explicit_js_mode.rst
@@ -1,7 +1,7 @@
 explicit_js_mode
 ----------------
 
-.. dune:stanza:: explicit_js_mode
+.. describe:: (explicit_js_mode ...)
 
    Do not implicitly add ``js`` to the ``(modes ...)`` field of executables.
 

diff --git a/doc/reference/files/dune-project/formatting.rst b/doc/reference/files/dune-project/formatting.rst
@@ -1,7 +1,7 @@
 formatting
 ----------
 
-.. dune:stanza:: formatting
+.. describe:: (formatting ...)
 
    .. versionadded:: 2.0
 

diff --git a/doc/reference/files/dune-project/generate_opam_files.rst b/doc/reference/files/dune-project/generate_opam_files.rst
@@ -1,7 +1,7 @@
 generate_opam_files
 -------------------
 
-.. dune:stanza:: generate_opam_files
+.. describe:: (generate_opam_files ...)
 
    Use metadata specified in the ``dune-project`` file to generate ``.opam``
    files.
@@ -18,8 +18,7 @@ generate_opam_files
 Dune uses the following global fields to set the metadata for all packages
 defined in the project:
 
-.. dune:stanza:: license
-   :param: <strings>
+.. describe:: (license <strings>)
 
    Specify the license of the project, ideally as an identifier from the `SPDX
    License List <https://spdx.org/licenses/>`__.
@@ -32,8 +31,7 @@ defined in the project:
 
    Multiple licenses may be specified.
 
-.. dune:stanza:: authors
-   :param: <strings>
+.. describe:: (authors <strings>)
 
    Specify authors.
 
@@ -45,8 +43,7 @@ defined in the project:
        "Jane Doe <jane.doe@example.com>"
        "John Doe <john.doe@example.com>")
 
-.. dune:stanza:: maintainers
-   :param: <strings>
+.. describe:: (maintainers <strings>)
 
    Specify maintainers.
 
@@ -58,7 +55,7 @@ defined in the project:
        "Jane Doe <jane.doe@example.com>"
        "John Doe <john.doe@example.com>")
 
-.. dune:stanza:: source
+.. describe:: (source ...)
 
    Specify where the source for the package can be found.
 
@@ -90,8 +87,7 @@ defined in the project:
       (source
        (uri https://dev.example.com/project.git))
 
-.. dune:stanza:: bug_reports
-   :param: <url>
+.. describe:: (bug_reports <url>)
 
    Where bugs should be reported.
 
@@ -103,8 +99,7 @@ defined in the project:
 
       (bug_reports https://dev.example.com/project/issues)
 
-.. dune:stanza:: homepage
-   :param: <url>
+.. describe:: (homepage <url>)
 
    The homepage of the project.
 
@@ -116,8 +111,7 @@ defined in the project:
 
       (bug_reports https://example.com/)
 
-.. dune:stanza:: documentation
-   :param: <url>
+.. describe:: (documentation <url>)
 
    Where the documentation is hosted.
 

diff --git a/doc/reference/files/dune-project/implicit_transitive_deps.rst b/doc/reference/files/dune-project/implicit_transitive_deps.rst
@@ -1,7 +1,7 @@
 implicit_transitive_deps
 ------------------------
 
-.. dune:stanza:: implicit_transitive_deps
+.. describe:: (implicit_transitive_deps ...)
 
    Control whether transitive dependencies are made implicitly visible.
 

diff --git a/doc/reference/files/dune-project/map_workspace_root.rst b/doc/reference/files/dune-project/map_workspace_root.rst
@@ -1,8 +1,7 @@
 map_workspace_root
 -------------------
 
-.. dune:stanza:: map_workspace_root
-   :param: <bool>
+.. describe:: (map_workspace_root <bool>)
 
    Control references to the file system locations where the project has been
    built.

diff --git a/doc/reference/files/dune-project/name.rst b/doc/reference/files/dune-project/name.rst
@@ -1,8 +1,7 @@
 name
 ----
 
-.. dune:stanza:: name
-   :param: <string>
+.. describe:: (name <string>)
 
    Set the name of the project.
 

diff --git a/doc/reference/files/dune-project/opam_file_location.rst b/doc/reference/files/dune-project/opam_file_location.rst
@@ -1,8 +1,7 @@
 opam_file_location
 ------------------
 
-.. dune:stanza:: opam_file_location
-   :param: <location>
+.. describe:: (opam_file_location <location>)
 
    .. versionadded:: 3.8
 

diff --git a/doc/reference/files/dune-project/package.rst b/doc/reference/files/dune-project/package.rst
@@ -1,7 +1,7 @@
 package
 -------
 
-.. dune:stanza:: package
+.. describe:: (package ...)
 
    Define package-specific metadata.
 

diff --git a/doc/reference/files/dune-project/subst.rst b/doc/reference/files/dune-project/subst.rst
@@ -1,8 +1,7 @@
 subst
 -----
 
-.. dune:stanza:: subst
-   :param: <bool>
+.. describe:: (subst <bool>)
 
    .. versionadded: 3.0
 

diff --git a/doc/reference/files/dune-project/use_standard_c_and_cxx_flags.rst b/doc/reference/files/dune-project/use_standard_c_and_cxx_flags.rst
@@ -1,7 +1,7 @@
 use_standard_c_and_cxx_flags
 ----------------------------
 
-.. dune:stanza:: use_standard_c_and_cxx_flags
+.. describe:: (use_standard_c_and_cxx_flags ...)
 
    .. versionadded:: 2.8
 

diff --git a/doc/reference/files/dune-project/using.rst b/doc/reference/files/dune-project/using.rst
@@ -1,8 +1,7 @@
 using
 -----
 
-.. dune:stanza:: using
-   :param: <plugin> <version>
+.. describe:: (using <plugin> <version>)
 
    Enable a dune language extension.
 

diff --git a/doc/reference/files/dune-project/version.rst b/doc/reference/files/dune-project/version.rst
@@ -1,8 +1,7 @@
 version
 -------
 
-.. dune:stanza:: version
-   :param: <version>
+.. describe:: (version <version>)
 
    Set the version of the project.
 

diff --git a/doc/reference/files/dune-project/warnings.rst b/doc/reference/files/dune-project/warnings.rst
@@ -1,7 +1,7 @@
 warnings
 --------
 
-.. dune:stanza:: warnings
+.. describe:: (warnings ...)
 
    .. versionadded:: 3.11
 

diff --git a/doc/reference/files/dune-project/wrapped_executables.rst b/doc/reference/files/dune-project/wrapped_executables.rst
@@ -1,8 +1,7 @@
 wrapped_executables
 -------------------
 
-.. dune:stanza:: wrapped_executables
-   :param: <bool>
+.. describe:: (wrapped_executables <bool>)
 
    .. versionadded:: 1.11
 

diff --git a/doc/reference/files/dune/cram.rst b/doc/reference/files/dune/cram.rst
@@ -1,7 +1,7 @@
 Cram
 ----
 
-.. dune:stanza:: cram
+.. describe:: (cram ...)
 
    Configure Cram tests in the current directory (and subdirectories).