Extend developer docs

This commit is contained in:
Erik Kalkoken
2020-04-03 12:03:34 +00:00
committed by Ariel Rin
parent f28a50f92c
commit 170b246901
16 changed files with 840 additions and 4 deletions

View File

@@ -0,0 +1,39 @@
======================
django-esi
======================
The django-esi package provides an interface for easy access to the ESI.
Location: ``esi``
This is an external package. Please also see `here <https://gitlab.com/allianceauth/django-esi>`_ for it's official documentation.
clients
===========
.. automodule:: esi.clients
:members: esi_client_factory
:undoc-members:
decorators
===========
.. automodule:: esi.decorators
:members:
:undoc-members:
errors
===========
.. automodule:: esi.errors
:members:
:undoc-members:
models
===========
.. automodule:: esi.models
:members: Scope, Token
:exclude-members: objects, provider
:undoc-members:

View File

@@ -0,0 +1,30 @@
===============================
evelinks
===============================
This package generates profile URLs for eve entities on 3rd party websites like evewho and zKillboard.
Location: ``allianceauth.eveonline.evelinks``
dotlan
===============
.. automodule:: allianceauth.eveonline.evelinks.dotlan
:members:
:undoc-members:
eveho
==============
.. automodule:: allianceauth.eveonline.evelinks.evewho
:members:
:undoc-members:
zkillboard
===================
.. automodule:: allianceauth.eveonline.evelinks.zkillboard
:members:
:undoc-members:

View File

@@ -0,0 +1,15 @@
======================
eveonline
======================
The eveonline package provides models for commonly used Eve Online entities like characters, corporations and alliances. All models have the ability to be loaded from ESI.
Location: ``allianceauth.eveonline``
models
======
.. automodule:: allianceauth.eveonline.models
:members:
:exclude-members: objects, provider
:undoc-members:

View File

@@ -0,0 +1,13 @@
# API
To reduce redundancy and help speed up development we encourage developers to utilize the following packages when developing apps for Alliance Auth.
```eval_rst
.. toctree::
:maxdepth: 1
esi
evelinks
eveonline
testutils
```

View File

@@ -0,0 +1,14 @@
=============================
tests
=============================
Here you find utility functions and classes, which can help speed up writing test cases for AA.
Location: ``allianceauth.tests.auth_utils``
auth_utils
===========
.. automodule:: allianceauth.tests.auth_utils
:members:
:undoc-members: