Browse Source

Add module documentation

develop
Sam Black 5 years ago
parent
commit
48ef9f452f
  1. 37
      docs/developer/index.rst
  2. 72
      docs/developer/models.rst
  3. 7
      docs/developer/utils/forms.rst
  4. 12
      docs/developer/utils/index.rst
  5. 68
      docs/developer/utils/utils.rst
  6. 72
      docs/developer/views/forms.rst
  7. 14
      docs/developer/views/index.rst
  8. 7
      docs/developer/views/rest.rst
  9. 76
      docs/developer/views/views.rst

37
docs/developer/index.rst

@ -1,35 +1,24 @@
.. Vowel Developer documentation master file, created by
sphinx-quickstart on Mon Dec 14 21:32:02 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=============================
Vowel Developer documentation
=============================
Welcome to Vowel Developer's documentation!
===========================================
Contents:
Indices and tables
==================
.. toctree::
:name: mastertoc
:caption: Table of Contents
:maxdepth: 2
:titlesonly:
views/index.rst
utils/index.rst
models.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. autoflask:: vowel.web:create_app()
:undoc-static:
.. module:: vowel
.. automodule:: vowel
:members:
:undoc-members:
.. module:: vowel.views
.. automodule:: vowel.views.lesson
:members:
:undoc-members:

72
docs/developer/models.rst

@ -0,0 +1,72 @@
Models
======
.. module:: vowel.models
Annotations
-----------
.. automodule:: vowel.models.annotation
:members:
:undoc-members:
Assessment
----------
.. automodule:: vowel.models.assessments
:members:
:undoc-members:
Course
------
.. automodule:: vowel.models.courses
:members:
:undoc-members:
Dashboard
---------
No models.
Lesson
------
.. automodule:: vowel.models.lessons
:members:
:undoc-members:
Organisation
------------
.. automodule:: vowel.models.organisations
:members:
:undoc-members:
Presentation
------------
No models.
Resources
---------
.. automodule:: vowel.models.resources
:members:
:undoc-members:
Users
-----
.. automodule:: vowel.models.users
:members:
:undoc-members:

7
docs/developer/utils/forms.rst

@ -0,0 +1,7 @@
Form utilities
==============
.. module:: vowel.forms.utils
.. automodule:: vowel.forms.utils
:members:
:undoc-members:

12
docs/developer/utils/index.rst

@ -0,0 +1,12 @@
Utilities
=========
Utilities used in Vowel.
.. toctree::
:maxdepth: 2
:titlesonly:
forms.rst
utils.rst

68
docs/developer/utils/utils.rst

@ -0,0 +1,68 @@
Utility functions
=================
.. module:: vowel.utils
Authentication
--------------
.. automodule:: vowel.utils.auth
:members:
:undoc-members:
Course
------
.. automodule:: vowel.utils.course
:members:
:undoc-members:
Enrolment
---------
.. automodule:: vowel.utils.enrolment
:members:
:undoc-members:
Mail
----
.. automodule:: vowel.utils.mail
:members:
:undoc-members:
Queue
-----
.. automodule:: vowel.utils.queue
:members:
:undoc-members:
Resources
---------
.. automodule:: vowel.utils.resources
:members:
:undoc-members:
Route
-----
.. automodule:: vowel.utils.route
:members:
:undoc-members:
Users
-----
.. automodule:: vowel.utils.user
:members:
:undoc-members:

72
docs/developer/views/forms.rst

@ -0,0 +1,72 @@
View forms
==========
.. module:: vowel.forms
Annotations
-----------
No annotation forms.
Assessment
----------
.. automodule:: vowel.forms.assessment
:members:
:undoc-members:
Course
------
.. automodule:: vowel.forms.course
:members:
:undoc-members:
Dashboard
---------
No dashboard forms.
Lesson
------
.. automodule:: vowel.forms.lesson
:members:
:undoc-members:
Organisation
------------
.. automodule:: vowel.forms.organisation
:members:
:undoc-members:
Presentation
------------
.. automodule:: vowel.forms.presentation
:members:
:undoc-members:
Resources
---------
.. automodule:: vowel.forms.resources
:members:
:undoc-members:
Users
-----
.. automodule:: vowel.forms.users
:members:
:undoc-members:

14
docs/developer/views/index.rst

@ -0,0 +1,14 @@
Views
=====
View related documentation, such as
view functions, forms and Flask endpoints.
.. toctree::
:maxdepth: 2
:titlesonly:
views.rst
forms.rst
rest.rst

7
docs/developer/views/rest.rst

@ -0,0 +1,7 @@
View endpoints
==============
.. autoflask:: vowel.web:create_app()
:undoc-static:
:undoc-blueprints: debugtoolbar, security
:undoc-endpoints: _debug_toolbar.static

76
docs/developer/views/views.rst

@ -0,0 +1,76 @@
View functions
==============
.. module:: vowel.views
Annotations
-----------
.. automodule:: vowel.views.annotations
:members:
:undoc-members:
Assessment
----------
.. automodule:: vowel.views.assessment
:members:
:undoc-members:
Course
------
.. automodule:: vowel.views.course
:members:
:undoc-members:
Dashboard
---------
.. automodule:: vowel.views.dashboard
:members:
:undoc-members:
Lesson
------
.. automodule:: vowel.views.lesson
:members:
:undoc-members:
Organisation
------------
.. automodule:: vowel.views.organisation
:members:
:undoc-members:
Presentation
------------
.. automodule:: vowel.views.presentation
:members:
:undoc-members:
Resources
---------
.. automodule:: vowel.views.resources
:members:
:undoc-members:
Users
-----
.. automodule:: vowel.views.users
:members:
:undoc-members:
Loading…
Cancel
Save