Switch to ReadTheDocs

.readthedocs.yaml

@@ -0,0 +1,11 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.8"
+
+python:
+  install:
+  - requirements: requirements.txt
+  - path: .

README.rst

@@ -1,7 +1,7 @@
 *pliers*: a python package for automated feature extraction
 ===========================================================
 
-|PyPI version fury.io| |pytest| |Coverage Status|
+|PyPI version fury.io| |pytest| |Coverage Status| [docs]
 |DOI:10.1145/3097983.3098075|
 
 
@@ -52,62 +52,6 @@ Pliers is a general purpose tool, this is just one domain where it's useful.
 The above video is from a `tutorial <https://naturalistic-data.org/content/Pliers_Tutorial.html>`__
 as a part of a `course about naturalistic data <https://naturalistic-data.org/>`__.
 
-Installation
-------------
-
-Simply use pip to install the latest release:
-
-   pip install pliers
-
-Dependencies
-~~~~~~~~~~~~
-
-Installing pliers with pip will only install third-party
-libraries that are essential for pliers to function properly. However,
-because pliers provides interfaces to a large number of feature
-extraction tools, there are dozens of optional dependencies that may be
-required depending on what kinds of features you plan to extract. You
-may install dependencies piece meal (pliers will alert you if
-you're missing a depedency) or you may install all the required
-dependencies:
-
-   pip install -r optional-dependencies.txt
-
-Note, that some of these Python dependencies may have their own requirements. 
-For example, python-magic
-requires libmagic and without this, you’ll be relegated to loading all
-your stims explicitly rather than passing in filenames (i.e.,
-``stim = VideoStim('my_video.mp4')`` will work fine, but passing
-'my_video.mp4' directly to an ``Extractor`` may not).
-
-Docker image
-^^^^^^^^^^^^
-
-You may also use the provided Docker image which fulfills all the optional dependencies.
-
-:: 
-
-   docker run -p 8888:8888 ghcr.io/psychoinformaticslab/pliers:unstable
-
-Follow `these instructions <http://psychoinformaticslab.github.io/pliers/installation.html#docker>`__.
-
-API Keys
-^^^^^^^^
-
-While installing pliers itself is straightforward, configuring web-based
-feature extraction APIs can take a more
-effort. For example, pliers includes support for face and object
-recognition via Google’s Cloud Vision API, and enables conversion of
-audio files to text transcripts via several different speech-to-text
-services. While some of these APIs are free to use (and usually provide
-a limited number of free monthly calls), they require users to
-register to received API credentials. More details on API key setup
-are available
-`here <http://psychoinformaticslab.github.io/pliers/installation.html#api-keys>`__.
-
-Another option is to exclusively use local models and algorithms, such as
-the wide range covered by TensforFlow Hub using the ``TFHubExtractor``.
-
 How to cite
 -----------
 
@@ -126,3 +70,6 @@ If you use pliers in your work, please cite both the pliers and the following pa
    :target: https://coveralls.io/github/psychoinformaticslab/pliers?branch=master
 .. |DOI:10.1145/3097983.3098075| image:: https://zenodo.org/badge/DOI/10.1145/3097983.3098075.svg
    :target: https://doi.org/10.1145/3097983.3098075
+.. |docs| image:: https://readthedocs.org/projects/pliers/badge/?version=latest
+    :target: https://pliers.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status

docs/_includes/_replacements.rst

@@ -66,6 +66,7 @@
 .. |TFHubExtractor| replace:: :py:class:`TFHubExtractor`
 .. |TFHubImageExtractor| replace:: :py:class:`TFHubImageExtractor`
 .. |TFHubTextExtractor| replace:: :py:class:`TFHubTextExtractor`
+.. |MetricExtractor| replace:: :py:class:`MetricExtractor`
 
 
 .. currentmodule:: pliers.converters
@@ -91,10 +92,10 @@
 .. |FrameSamplingFilter| replace:: :py:class:`FrameSamplingFilter`
 .. |ImageCroppingFilter| replace:: :py:class:`ImageCroppingFilter`
 .. |PillowImageFilter| replace:: :py:class:`PillowImageFilter`
-.. |PunctuationRemovalFilter| replace :py:class:`PunctuationRemovalFilter`
-.. |TokenizingFilter| replace :py:class:`TokenizingFilter`
-.. |TokenRemovalFilter| replace :py:class:`TokenRemovalFilter`
-.. |WordStemmingFilter| replace :py:class:`WordStemmingFilter`
+.. |PunctuationRemovalFilter| replace:: :py:class:`PunctuationRemovalFilter`
+.. |TokenizingFilter| replace:: :py:class:`TokenizingFilter`
+.. |TokenRemovalFilter| replace:: :py:class:`TokenRemovalFilter`
+.. |WordStemmingFilter| replace:: :py:class:`WordStemmingFilter`
 .. |AudioResamplingFilter| replace:: :py:class:`AudioResamplingFilter`
 
 .. currentmodule:: pliers.graph

docs/conf.py

@@ -17,7 +17,12 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import sphinx_rtd_theme
+import sys
+import os
+sys.path.insert(0, os.path.abspath('../'))
+
 import pliers
+from pliers import *
 
 # -- General configuration ------------------------------------------------
 
@@ -30,7 +35,6 @@
 # ones.
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.autosummary',
-              'sphinx.ext.autosectionlabel',
               'sphinx.ext.intersphinx',
               'sphinx.ext.coverage',
               'sphinx.ext.mathjax',
@@ -67,17 +71,10 @@
 # The full version, including alpha/beta/rc tags.
 release = '0.4.1'
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'generated']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -105,22 +102,6 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-        'donate.html',
-    ]
-}
-
-
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
@@ -179,6 +160,4 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
-
-autoclass_content = 'class'
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/index.rst

@@ -3,7 +3,7 @@
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
    installation