Document the deprecation for other languages

readthedocs · Mar 28, 2023 · 5fa927c · 5fa927c
1 parent f440803
commit 5fa927c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -31,6 +31,10 @@ AutoAPI finds and generates documentation by parsing source code.
 Language Support
 ----------------
 
+.. warning::
+
+    Support for all languages other than Python will be removed in the next major version!
+
 ==========  ======  ==========================================================
 Language    Status  Parser
 ==========  ======  ==========================================================

diff --git a/docs/changes/+e2fe0940.misc.rst b/docs/changes/+e2fe0940.misc.rst
@@ -1,2 +1 @@
-
 Integrated towncrier into the release workflow.
diff --git a/docs/changes/248.removal.rst b/docs/changes/248.removal.rst
@@ -0,0 +1 @@
+Support for documenting languages other than Python is deprecated.
diff --git a/docs/reference/config.rst b/docs/reference/config.rst
@@ -30,6 +30,10 @@ Configuration Options
    .NET        ``'dotnet'``
    ==========  ================
 
+   .. warning::
+
+      Support for all languages other than Python will be removed in the next major version!
+
 .. confval:: autoapi_template_dir
 
    Default: ``''``

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -20,6 +20,10 @@ Javascript   ``pip install sphinx-autoapi``
 .NET         ``pip install sphinx-autoapi[dotnet]``
 ==========   ======================================
 
+.. warning::
+
+    Support for all languages other than Python will be removed in the next major version!
+
 Depending on which language you are trying to document,
 each language has a different set of steps for finishing the setup of AutoAPI:
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1 @@

		Integrated towncrier into the release workflow.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Support for documenting languages other than Python is deprecated.