docs: minor fixes

LICENSE

@@ -18,12 +18,3 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-This module includes the following external libraries:
-
-- PDF.js: https://mozilla.github.io/pdf.js/ licensed under Apache. Included in:
-  /assets/css/pdfjs
-  /assets/js/pdfjs
-  /static/css/pdfjs
-  /static/js/pdfjs

docs/api.rst

@@ -15,6 +15,30 @@ API Docs
    :undoc-members:
 
 
+API
+---
+
+.. automodule:: invenio_previewer.api
+   :members:
+   :undoc-members:
+
+
+Proxies
+-------
+
+.. automodule:: invenio_previewer.proxies
+   :members:
+   :undoc-members:
+
+
+Utils
+-----
+
+.. automodule:: invenio_previewer.utils
+   :members:
+   :undoc-members:
+
+
 Views
 -----
 
@@ -22,6 +46,15 @@ Views
    :members:
    :undoc-members:
 
+
+Webpack
+-------
+
+.. automodule:: invenio_previewer.webpack
+   :members:
+   :undoc-members:
+
+
 Previewers
 ----------
 
@@ -85,6 +118,6 @@ ZIP
 Bundles
 -------
 
-.. automodule:: invenio_previewer.webpack
+.. automodule:: invenio_previewer.bundles
    :members:
    :undoc-members:

docs/license.rst

@@ -7,3 +7,13 @@ License
     In applying this license, CERN does not waive the privileges and immunities
     granted to it by virtue of its status as an Intergovernmental Organization or
     submit itself to any jurisdiction.
+
+Invenio-Preivewer includes the following external libraries:
+
+- **PDF.js**, Copyright 2012 Mozilla Foundation, licensed under Apache License
+  2.0. The source code is found under:
+
+    - ``/assets/css/pdfjs``
+    - ``/assets/js/pdfjs``
+    - ``/static/css/pdfjs``
+    - ``/static/js/pdfjs``

invenio_previewer/bundles.py

@@ -6,7 +6,12 @@
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-"""Previewer bundles."""
+"""Previewer bundles.
+
+.. deprecated:: 1.0.0
+    AMD/RequireJS based bundles have been deprecated in Invenio v3.0 and will
+    be removed.
+"""
 
 from __future__ import unicode_literals
 

invenio_previewer/proxies.py

@@ -15,3 +15,4 @@ from werkzeug.local import LocalProxy
 
 current_previewer = LocalProxy(
     lambda: current_app.extensions['invenio-previewer'])
+"""Proxy object to the current previewer extension."""

invenio_previewer/webpack.py

@@ -50,3 +50,4 @@ previewer = WebpackBundle(
         'prismjs': '^1.15.0',
     }
 )
+"""Bundle of webpack assets."""