enhance doc

burpui/api/client.py

@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-.. module:: client
+.. module:: burpui.api.client
     :platform: Unix
     :synopsis: Burp-UI client api module.
 

burpui/api/clients.py

@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-.. module:: clients
+.. module:: burpui.api.clients
     :platform: Unix
     :synopsis: Burp-UI clients api module.
 

burpui/api/misc.py

@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-.. module:: misc
+.. module:: burpui.api.misc
     :platform: Unix
     :synopsis: Burp-UI misc api module.
 

burpui/api/restore.py

@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-.. module:: restore
+.. module:: burpui.api.restore
     :platform: Unix
     :synopsis: Burp-UI restore api module.
 

burpui/api/settings.py

@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-.. module:: settings
+.. module:: burpui.api.settings
     :platform: Unix
     :synopsis: Burp-UI settings api module.
 

burpui/misc/backend/interface.py

@@ -1,4 +1,12 @@
 # -*- coding: utf8 -*-
+"""
+.. module:: burpui.misc.backend.interface
+    :platform: Unix
+    :synopsis: Burp-UI settings api module.
+
+.. moduleauthor:: Ziirish <ziirish@ziirish.info>
+
+"""
 
 
 class BUIbackend:

docs/api.rst

@@ -1,4 +1,4 @@
-API doc (for dev)
-=================
+API
+===
 
 .. autoflask:: burpui:app

docs/backend.rst

@@ -0,0 +1,6 @@
+Backend
+=======
+
+.. autoclass:: burpui.misc.backend.interface.BUIbackend
+   :members:
+   :inherited-members:

docs/developer.rst

@@ -0,0 +1,8 @@
+Developer Guide
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   backend

docs/index.rst

@@ -26,7 +26,7 @@ Documentation
    contributing
    changelog
    faq
-   api
+   developer
 
 
 Indices and tables