Update documentation building configuration

docs/rtd_environment.yml

@@ -1,20 +1,30 @@
 name: menpo_rtd
 channels:
-  - menpo
+  - conda-forge
 dependencies:
-  - python
+  - python 3.7.*
   - setuptools
   - cython>=0.23
-  - pathlib=1.0
 
-  - numpy>=1.10,<2.0
-  - scipy>=0.16,<1.0
-  - pillow>=3.0,<4.0
-  - cyvlfeat>=0.4.3,<0.5
-  - matplotlib>=1.4,<2.0
-  - mock
-  - nose
+  # Scientific Python Stack
+  - numpy >=1.14,<2.0
+  - scipy >=1.0,<2.0
+  - pillow >=4.0,<6.0
+  - ffmpeg >=2.7,<5.0
+
+  # Visualization
+  - matplotlib >=3.0,<4.0
+
+  # Optional Dependencies
+  - cyvlfeat >=0.5.0,<0.6.0
+
+  # Testing
+  - pytest >=5.0,<6.0
+  - pytest-cov >=2.0,<3.0
+  - mock >=3.0,<4.0
+
+  # Docs Only
+  - sphinx >=2,<3
+  - sphinx_rtd_theme
   - pip:
-      - sphinx
-      - sphinx_rtd_theme
       - sphinxmapxrefrole>=0.2

docs/source/api/feature/index.rst

@@ -70,7 +70,6 @@ Visualization
 .. toctree::
   :maxdepth: 2
 
-  glyph
   sum_channels
 
 

docs/source/conf.py

@@ -1,6 +1,5 @@
-import sys
 import os
-
+import sys
 
 # on_rtd is whether we are on readthedocs.org,
 # this line of code grabbed from docs.readthedocs.org
@@ -10,18 +9,20 @@
 sys.path.insert(0, os.path.abspath('..'))
 
 if not on_rtd:
-  # Add the menpo root so we can grab the version
-  sys.path.insert(0, os.path.abspath('../../'))
+    # Add the menpo root so we can grab the version
+    sys.path.insert(0, os.path.abspath('../../'))
 
 import menpo
+# Import the mapping dictionary and set it for sphinxmapxrefrole
+from xref_map import xref_map
 
 # add an up to date mathjax path
 mathjax_path = 'https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.3'
+needs_sphinx = '2.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -36,8 +37,6 @@
               'sphinxext.theme_hack',
               'sphinxmapxrefrole']
 
-# Import the mapping dictionary and set it for sphinxmapxrefrole
-from xref_map import xref_map
 xref_mapping_dict = xref_map
 
 # Add any paths that contain templates here, relative to this directory.
@@ -55,10 +54,10 @@
 napoleon_use_admonition_for_references = True
 
 # The suffix of source filenames.
-#source_suffix = '.rst'
+# source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -83,40 +82,40 @@
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build', '**/test/**']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-#pygments_style = 'sphinx'
+# pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ---------------------------------------------------
@@ -132,89 +131,88 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Menpodoc'
 
-
 # -- Options for LaTeX output --------------------------------------------------
 
-latex_preamble = """
+latex_preamble = r"""
 \usepackage{enumitem}
 \setlistdepth{999}
 """
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
 
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    # 'pointsize': '10pt',
 
     # Additional stuff for the LaTeX preamble.
     'preamble': latex_preamble
@@ -229,23 +227,23 @@
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
@@ -258,7 +256,7 @@
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -274,13 +272,13 @@
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False

readthedocs.yml

@@ -1,9 +1,16 @@
-formats:
-  - pdf
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+formats: all
 
 conda:
-  file: docs/rtd_environment.yml
+  environment: docs/rtd_environment.yml
 
 python:
-   setup_py_install: true
-
+  version: 3.7
+  install:
+    - method: pip
+      path: .

setup.py

@@ -97,10 +97,10 @@ def build_extension_from_pyx(pyx_path, extra_sources_paths=None):
                         language_level=sys.version_info[0])
 
 # Please see conda/meta.yaml for other binary dependencies
-install_requires = ['numpy>=1.10',
-                    'scipy>=0.16',
-                    'matplotlib>=1.4',
-                    'pillow>=3.0']
+install_requires = ['numpy>=1.14',
+                    'scipy>=1.0',
+                    'matplotlib>=3.0',
+                    'pillow>=4.0']
 
 if sys.version_info.major == 2:
     install_requires.append('pathlib==1.0')
@@ -115,5 +115,5 @@ def build_extension_from_pyx(pyx_path, extra_sources_paths=None):
       packages=find_packages(),
       install_requires=install_requires,
       package_data={'menpo': ['data/*']},
-      tests_require=['pytest>=3.0', 'mock']
+      tests_require=['pytest>=5.0', 'mock>=3.0']
       )