Skip to content

Commit

Permalink
Maintenance update (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
ewu63 authored Oct 7, 2020
1 parent 3f3559a commit 35c8c13
Show file tree
Hide file tree
Showing 11 changed files with 523 additions and 1,767 deletions.
19 changes: 19 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import:
- mdolab/.github:travis/jobs-env.yml
- mdolab/.github:travis/before-install.yml
- mdolab/.github:travis/script.yml

env:
global:
- DOCKER_REPO=public

install:
- docker exec -it app /bin/bash -c ". $BASHRC && cd $DOCKER_WORKING_DIR && pip install ."

script:
- if [[ "$TEST_TYPE" == "docker" ]]; then
docker exec -it app /bin/bash -c ". $BASHRC && cd $DOCKER_WORKING_DIR && testflo . -v";
fi

after_script:
- docker rm -f app
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
Multipoint
====================================================
# Multipoint
[![Build Status](https://travis-ci.com/mdolab/multipoint.svg?branch=master)](https://travis-ci.com/mdolab/multipoint)
[![Documentation Status](https://readthedocs.com/projects/mdolab-multipoint/badge/?version=latest)](https://mdolab-multipoint.readthedocs-hosted.com/en/latest/?badge=latest)

Provides utilities to facilitates distributed multipoint optimization with the MACH framework.

Documentation
-------------

## Documentation
Please see the [documentation](https://mdolab-multipoint.readthedocs-hosted.com) for API documentation.

To locally build the documentation, enter the `doc` folder and enter `make html` in terminal.
You can then view the built documentation in the `_build` folder.

License
-------

Copyright 2019 MDO Lab. See the LICENSE file for details.
## License
Copyright 2020 MDO Lab. See the LICENSE file for details.
24 changes: 12 additions & 12 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,43 @@
# 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.
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath("../"))

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

# 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.viewcode', 'numpydoc', 'sphinx.ext.autosummary']
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "numpydoc", "sphinx.ext.autosummary"]
numpydoc_show_class_members = False

# mock import for autodoc
autodoc_mock_imports = ['numpy', 'mpi4py']
autodoc_mock_imports = ["numpy", "mpi4py"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = 'multiPoint'
copyright = '2020, MDO Lab'
project = "multiPoint"
copyright = "2020, MDO Lab"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ["_build"]

# -- 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_path = ['themes']
html_theme = 'sphinx_rtd_theme'
html_theme_path = ["themes"]
html_theme = "sphinx_rtd_theme"

# 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"]
9 changes: 4 additions & 5 deletions multipoint/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
__version__ = '1.2.0'
__version__ = "1.3.0"


from .multiPoint import multiPoint
from .multiPointSparse import multiPointSparse
from .multiPointSparse import createGroups
from .multiPointSparse import redirectIO
from .utils import createGroups
from .utils import redirectIO

__all__ = ['multiPoint', 'multiPointSparse', 'createGroups', 'redirectIO']
__all__ = ["multiPointSparse", "createGroups", "redirectIO"]
Loading

0 comments on commit 35c8c13

Please sign in to comment.