diff --git a/README.rst b/README.rst index efc122a..897821d 100644 --- 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 index 6d2019b..fcc13a1 100644 --- 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 new file mode 100644 index 0000000..f89edde --- /dev/null +++ b/docs/changes/248.removal.rst @@ -0,0 +1 @@ +Support for documenting languages other than Python is deprecated. \ No newline at end of file diff --git a/docs/reference/config.rst b/docs/reference/config.rst index f8a5b47..5df123e 100644 --- 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 index 4738d57..2aa4901 100644 --- 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: