Added documentation for optional dependencies

pull/176/head
Ashley Whetter 5 years ago
parent 45ff03a3ad
commit 900072e99b

@ -13,6 +13,7 @@ Features
* (Python) Added autoapidecorator directive with Sphinx >= 2.0.
* (Python) Can use autodoc_docstring_signature with Autodoc-style directives.
* Made it more clear which file causes an error, when an error occurs.
* Sphinx language domains are now optional dependencies.
Bug Fixes
^^^^^^^^^

@ -11,7 +11,14 @@ you can following the :doc:`sphinx:usage/quickstart` guide in the Sphinx documen
The recommended way of installing AutoAPI is through a `virtualenv <https://virtualenv.pypa.io/>`_.
Once you have a virtualenv set up, you can install AutoAPI with the command::
pip install sphinx-autoapi
========== ==========================================================
Language Command
========== ==========================================================
Python ``pip install sphinx-autoapi``
Go ``pip install sphinx-autoapi[go]``
Javascript ``pip install sphinx-autoapi``
.NET ``pip install sphinx-autoapi[dotnet]``
========== ==========================================================
Depending on which language you are trying to document,
each language has a different set of steps for finishing the setup of AutoAPI:

@ -16,11 +16,12 @@ python =
[testenv]
setenv =
LANG=C
extras =
dotnet
go
deps = -r{toxinidir}/requirements.txt
pytest
mock
sphinxcontrib-golangdomain
sphinxcontrib-dotnetdomain
sphinx16: Sphinx<1.7
sphinx17: Sphinx<1.8
sphinx18: Sphinx<1.9
@ -31,12 +32,14 @@ commands =
[testenv:formatting]
basepython = python3
skip_install = true
deps =
black
commands =
black --check autoapi tests
[testenv:lint]
skip_install = true
deps =
prospector
commands =

Loading…
Cancel
Save