Skip to content

Commit d5e684a

Browse files
jonathan-j-leejonathan-j-lee
authored
Fixes, Sphinx docs (#205)
* Fixed response lifetime being way too short * Added warning * Documentation update * Added updated Makefile and built documentation * Fixed feature phone * Updated docstrings for feature phone qualitative views * Trigger Travis to rebuild (weird MySQL socket failing) * Fixed line too long
1 parent 700c082 commit d5e684a

File tree

79 files changed

+4112
-1702
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+4112
-1702
lines changed

‎Makefile

+5-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ DB_TRANS_TARGETS=\
3131
EXCLUDED_MODULES=\
3232
$(DJANGO_PROJECT_ROOT)/pcari/migrations\
3333
$(DJANGO_PROJECT_ROOT)/pcari/test*\
34-
$(DJANGO_PROJECT_ROOT)/pcari/urls.py
34+
$(DJANGO_PROJECT_ROOT)/pcari/urls.py\
35+
$(DJANGO_PROJECT_ROOT)/feature_phone/migrations\
36+
$(DJANGO_PROJECT_ROOT)/feature_phone/test*\
37+
$(DJANGO_PROJECT_ROOT)/feature_phone/urls.py\
3538

3639
CLEANTEXT_TARGETS=\
3740
Comment.message\
@@ -63,6 +66,7 @@ testclient:
6366
preparedocs:
6467
mkdir -p $(DOCS_BUILD_PATH)
6568
sphinx-apidoc -f -e -o $(DOCS_BUILD_PATH)/source $(DJANGO_PROJECT_ROOT)/pcari $(EXCLUDED_MODULES)
69+
sphinx-apidoc -f -e -o $(DOCS_BUILD_PATH)/source $(DJANGO_PROJECT_ROOT)/feature_phone $(EXCLUDED_MODULES)
6670

6771
compiledocs:
6872
rm -rf $(DOCS_PATH)

‎docs-build/source/feature_phone.admin.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.admin module
2+
===========================
3+
4+
.. automodule:: feature_phone.admin
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs-build/source/feature_phone.apps.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.apps module
2+
==========================
3+
4+
.. automodule:: feature_phone.apps
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs-build/source/feature_phone.models.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.models module
2+
============================
3+
4+
.. automodule:: feature_phone.models
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs-build/source/feature_phone.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
feature\_phone package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
9+
feature_phone.admin
10+
feature_phone.apps
11+
feature_phone.models
12+
feature_phone.views
13+
14+
Module contents
15+
---------------
16+
17+
.. automodule:: feature_phone
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:

‎docs-build/source/feature_phone.views.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.views module
2+
===========================
3+
4+
.. automodule:: feature_phone.views
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs-build/source/index.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,18 @@ Welcome to Malasakit's documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13-
PCARI application <pcari>
13+
Web frontend <pcari>
14+
Feature phone frontend <feature_phone>
1415

1516
Malasakit is a customizable participatory assessment platform written in Django
1617
that collects and integrates quantitative assessment, qualitative feedback, and
1718
peer-to-peer collaborative filtering on ways local communities can become
1819
better prepared for typhoons and floods.
1920

20-
The project code is on `GitHub <https://github.com/BerkeleyAutomation/malasakit-v1>`_.
21+
The project code is on `GitHub <https://github.com/BerkeleyAutomation/malasakit>`_.
2122
Supplementary documentation for the project lives on the repository wiki. To get started,
22-
see the `setup instructions <https://github.com/BerkeleyAutomation/malasakit-v1/wiki/Setup>`_
23-
and the `guidelines for contributing <https://github.com/BerkeleyAutomation/malasakit-v1/wiki/Guidelines-for-Contributing>`_
23+
see the `setup instructions <https://github.com/BerkeleyAutomation/malasakit/wiki/Setup>`_
24+
and the `guidelines for contributing <https://github.com/BerkeleyAutomation/malasakit/wiki/Guidelines-for-Contributing>`_
2425
to the project.
2526

2627
Indices and tables

‎docs-build/source/modules.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
pcari
2-
=====
1+
feature_phone
2+
=============
33

44
.. toctree::
55
:maxdepth: 4
66

7-
pcari
7+
feature_phone

‎docs-build/source/pcari.admin.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.admin module
2-
===================
1+
pcari.admin module
2+
==================
33

44
.. automodule:: pcari.admin
55
:members:

‎docs-build/source/pcari.apps.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.apps module
2-
==================
1+
pcari.apps module
2+
=================
33

44
.. automodule:: pcari.apps
55
:members:

‎docs-build/source/pcari.management.commands.cleantext.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands\.cleantext module
2-
=============================================
1+
pcari.management.commands.cleantext module
2+
==========================================
33

44
.. automodule:: pcari.management.commands.cleantext
55
:members:

‎docs-build/source/pcari.management.commands.makedbtrans.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands\.makedbtrans module
2-
===============================================
1+
pcari.management.commands.makedbtrans module
2+
============================================
33

44
.. automodule:: pcari.management.commands.makedbtrans
55
:members:

‎docs-build/source/pcari.management.commands.makemessages.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands\.makemessages module
2-
================================================
1+
pcari.management.commands.makemessages module
2+
=============================================
33

44
.. automodule:: pcari.management.commands.makemessages
55
:members:

‎docs-build/source/pcari.management.commands.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands package
2-
===================================
1+
pcari.management.commands package
2+
=================================
33

44
Submodules
55
----------

‎docs-build/source/pcari.management.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management package
2-
=========================
1+
pcari.management package
2+
========================
33

44
Subpackages
55
-----------

‎docs-build/source/pcari.models.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
pcari\.models module
2-
====================
1+
pcari.models module
2+
===================
33

44
.. automodule:: pcari.models
5-
:members: History, StatisticsMixin, Question, Response, Rating, QuantitativeQuestion, QuantitativeQuestionRating, QualitativeQuestion, Comment, CommentRating, OptionQuestion, OptionQuestionChoice, Respondent
5+
:members:
66
:undoc-members:
77
:show-inheritance:

‎docs-build/source/pcari.rst

-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
pcari package
22
=============
33

4-
Subpackages
5-
-----------
6-
7-
.. toctree::
8-
9-
pcari.management
10-
pcari.templatetags
11-
124
Submodules
135
----------
146

‎docs-build/source/pcari.signals.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.signals module
2-
=====================
1+
pcari.signals module
2+
====================
33

44
.. automodule:: pcari.signals
55
:members:

‎docs-build/source/pcari.templatetags.localize_url.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.templatetags\.localize\_url module
2-
=========================================
1+
pcari.templatetags.localize\_url module
2+
=======================================
33

44
.. automodule:: pcari.templatetags.localize_url
55
:members:

‎docs-build/source/pcari.templatetags.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.templatetags package
2-
===========================
1+
pcari.templatetags package
2+
==========================
33

44
Submodules
55
----------

‎docs-build/source/pcari.views.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.views module
2-
===================
1+
pcari.views module
2+
==================
33

44
.. automodule:: pcari.views
55
:members:

‎docs/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5f9cfc8c291ad442e84b8664681b35d9
3+
config: 3404425c52742f0bfde80b6436acc5c4
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/feature_phone.admin.rst.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.admin module
2+
===========================
3+
4+
.. automodule:: feature_phone.admin
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/_sources/feature_phone.apps.rst.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.apps module
2+
==========================
3+
4+
.. automodule:: feature_phone.apps
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/_sources/feature_phone.models.rst.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.models module
2+
============================
3+
4+
.. automodule:: feature_phone.models
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/_sources/feature_phone.rst.txt

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
feature\_phone package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
9+
feature_phone.admin
10+
feature_phone.apps
11+
feature_phone.models
12+
feature_phone.views
13+
14+
Module contents
15+
---------------
16+
17+
.. automodule:: feature_phone
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:

‎docs/_sources/feature_phone.views.rst.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
feature\_phone.views module
2+
===========================
3+
4+
.. automodule:: feature_phone.views
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/_sources/index.rst.txt

+5-4
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,18 @@ Welcome to Malasakit's documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13-
PCARI application <pcari>
13+
Web frontend <pcari>
14+
Feature phone frontend <feature_phone>
1415

1516
Malasakit is a customizable participatory assessment platform written in Django
1617
that collects and integrates quantitative assessment, qualitative feedback, and
1718
peer-to-peer collaborative filtering on ways local communities can become
1819
better prepared for typhoons and floods.
1920

20-
The project code is on `GitHub <https://github.com/BerkeleyAutomation/malasakit-v1>`_.
21+
The project code is on `GitHub <https://github.com/BerkeleyAutomation/malasakit>`_.
2122
Supplementary documentation for the project lives on the repository wiki. To get started,
22-
see the `setup instructions <https://github.com/BerkeleyAutomation/malasakit-v1/wiki/Setup>`_
23-
and the `guidelines for contributing <https://github.com/BerkeleyAutomation/malasakit-v1/wiki/Guidelines-for-Contributing>`_
23+
see the `setup instructions <https://github.com/BerkeleyAutomation/malasakit/wiki/Setup>`_
24+
and the `guidelines for contributing <https://github.com/BerkeleyAutomation/malasakit/wiki/Guidelines-for-Contributing>`_
2425
to the project.
2526

2627
Indices and tables

‎docs/_sources/modules.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
pcari
2-
=====
1+
feature_phone
2+
=============
33

44
.. toctree::
55
:maxdepth: 4
66

7-
pcari
7+
feature_phone

‎docs/_sources/pcari.admin.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.admin module
2-
===================
1+
pcari.admin module
2+
==================
33

44
.. automodule:: pcari.admin
55
:members:

‎docs/_sources/pcari.apps.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.apps module
2-
==================
1+
pcari.apps module
2+
=================
33

44
.. automodule:: pcari.apps
55
:members:

‎docs/_sources/pcari.management.commands.cleantext.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands\.cleantext module
2-
=============================================
1+
pcari.management.commands.cleantext module
2+
==========================================
33

44
.. automodule:: pcari.management.commands.cleantext
55
:members:

‎docs/_sources/pcari.management.commands.makedbtrans.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands\.makedbtrans module
2-
===============================================
1+
pcari.management.commands.makedbtrans module
2+
============================================
33

44
.. automodule:: pcari.management.commands.makedbtrans
55
:members:

‎docs/_sources/pcari.management.commands.makemessages.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands\.makemessages module
2-
================================================
1+
pcari.management.commands.makemessages module
2+
=============================================
33

44
.. automodule:: pcari.management.commands.makemessages
55
:members:

‎docs/_sources/pcari.management.commands.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management\.commands package
2-
===================================
1+
pcari.management.commands package
2+
=================================
33

44
Submodules
55
----------

‎docs/_sources/pcari.management.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pcari\.management package
2-
=========================
1+
pcari.management package
2+
========================
33

44
Subpackages
55
-----------

‎docs/_sources/pcari.models.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
pcari\.models module
2-
====================
1+
pcari.models module
2+
===================
33

44
.. automodule:: pcari.models
5-
:members: History, StatisticsMixin, Question, Response, Rating, QuantitativeQuestion, QuantitativeQuestionRating, QualitativeQuestion, Comment, CommentRating, OptionQuestion, OptionQuestionChoice, Respondent
5+
:members:
66
:undoc-members:
77
:show-inheritance:

‎docs/_sources/pcari.rst.txt

-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
pcari package
22
=============
33

4-
Subpackages
5-
-----------
6-
7-
.. toctree::
8-
9-
pcari.management
10-
pcari.templatetags
11-
124
Submodules
135
----------
146

0 commit comments

Comments
 (0)