Skip to content

Commit

Permalink
update docs, remove mock from tests requirements, bumpt to 1.6.3
Browse files Browse the repository at this point in the history
  • Loading branch information
johny-c committed Nov 4, 2018
1 parent 533cc4d commit 3f91245
Show file tree
Hide file tree
Showing 6 changed files with 81 additions and 98 deletions.
1 change: 0 additions & 1 deletion docs/Makefile
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = PyLMNN
SOURCEDIR = .
BUILDDIR = _build

Expand Down
133 changes: 78 additions & 55 deletions docs/conf.py
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,42 +1,36 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# PyLMNN documentation build configuration file, created by
# sphinx-quickstart on Wed Mar 15 20:46:40 2017.
# Configuration file for the Sphinx documentation builder.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

sys.path.insert(0, os.path.abspath('..'))

# For autodoc to produce the source code in readthedocs.io
import mock

MOCK_MODULES = ['numpy', 'scipy', 'sklearn',
'numpy.linalg',
'sklearn.datasets', 'sklearn.utils', 'sklearn.utils.validation', 'sklearn.model_selection',
'sklearn.metrics', 'sklearn.metrics.pairwise',
'GPyOpt', 'GPyOpt.methods',
'matplotlib', 'matplotlib.pyplot', 'matplotlib.axes', 'mpl_toolkits.mplot3d'
]
# -- Project information -----------------------------------------------------

project = 'PyLMNN'
copyright = '2018, John Chiotellis'
author = 'John Chiotellis'

from setup import __version__

for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.Mock()
version = __version__
# The full version, including alpha/beta/rc tags.
release = __version__

# -- General configuration ------------------------------------------------

# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
Expand All @@ -45,12 +39,16 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -64,21 +62,6 @@
# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'PyLMNN'
copyright = '2017, John Chiotellis'
author = 'John Chiotellis'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
from setup import __version__

version = __version__
# The full version, including alpha/beta/rc tags.
release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand All @@ -88,21 +71,19 @@

# 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
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = None

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# -- Options for HTML output ----------------------------------------------
# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_theme = 'sphinx_rtd_theme'

# 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
Expand All @@ -115,12 +96,24 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# -- Options for HTMLHelp output ------------------------------------------
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'PyLMNNdoc'

# -- Options for LaTeX output ---------------------------------------------

# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
Expand Down Expand Up @@ -148,7 +141,8 @@
'John Chiotellis', 'manual'),
]

# -- Options for manual page output ---------------------------------------

# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
Expand All @@ -157,7 +151,8 @@
[author], 1)
]

# -- Options for Texinfo output -------------------------------------------

# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
Expand All @@ -168,5 +163,33 @@
'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
4 changes: 2 additions & 2 deletions docs/index.rst
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. PyLMNN documentation master file, created by
sphinx-quickstart on Wed Mar 15 20:46:40 2017.
sphinx-quickstart on Sun Nov 4 21:24:00 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyLMNN's documentation!
==================================

.. toctree::
:maxdepth: 4
:maxdepth: 2
:caption: Contents:

readme
Expand Down
36 changes: 0 additions & 36 deletions docs/make.bat

This file was deleted.

2 changes: 0 additions & 2 deletions docs/requirements.txt

This file was deleted.

3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from codecs import open
from os import path

__version__ = '1.6.2'
__version__ = '1.6.3'

if __name__ == '__main__':
here = path.abspath(path.dirname(__file__))
Expand Down Expand Up @@ -42,6 +42,5 @@
'scikit_learn>=0.18'],

tests_require=[
'mock>=0.8, <3.0',
'pytest>=3.0.1, <4.0'],
)

0 comments on commit 3f91245

Please sign in to comment.