Document the deprecation for other languages

1 year ago · 5fa927c682
parent f44080391b
commit 5fa927c682
5 changed files with 13 additions and 1 deletions
--- 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
 ==========  ======  ==========================================================
--- a/docs/changes/+e2fe0940.misc.rst
+++ b/docs/changes/+e2fe0940.misc.rst
@ -1,2 +1 @@
-
 Integrated towncrier into the release workflow.
--- a/docs/changes/248.removal.rst
+++ b/docs/changes/248.removal.rst
@ -0,0 +1 @@
+Support for documenting languages other than Python is deprecated.
--- 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: ``''``
--- 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:
				`@ -1,2 +1 @@`

				`Integrated towncrier into the release workflow.`
				`@ -0,0 +1 @@`
				`Support for documenting languages other than Python is deprecated.`