Commit 6cacc0dd authored by Frederik Zahle's avatar Frederik Zahle
Browse files

added clean plugin

parent b99e28ff
graft src/SEAMAero/sphinx_build/html
recursive-include src/SEAMAero/test *.py
# This file is autogenerated during plugin quickstart and overwritten during
# plugin makedist and plugin build_docs. DO NOT CHANGE IT if you plan to
# use plugin makedist to package the distribution.
# -*- coding: utf-8 -*-
# This file is execfile()d with the current directory set to its containing dir.
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
import sys, os
def _sys_path_add(toadd=None):
if toadd:
distdir = os.path.dirname(os.path.dirname(__file__))
sys.path = [distdir] + [os.path.join(distdir, p) for p in toadd] + sys.path
# 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.intersphinx',
'sphinx.ext.doctest', 'sphinx.ext.todo','openmdao.util.doctools',
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'SEAMAero'
copyright = u''
# 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.
# The short X.Y version.
version = '0.1'
#The short version is the one that shows up in the file when you use /version/.
# The full version, including alpha/beta/rc tags.
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%B %d, %Y'
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# Options for HTML output
# -----------------------
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
html_style = 'default.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#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
# 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
# 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' ]
# 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'
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
#html_copy_source = 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_theme = "default"
# using these theme options will make the docs share a consistent
# look with the OpenMDAO docs
html_theme_options = {
"headtextcolor": "#000099",
"headbgcolor": "#e2b530",
"headfont": "Arial",
"relbarbgcolor": "#000099",
"relbartextcolor": "white",
"relbarlinkcolor": "white",
"sidebarbgcolor": "#c7c7c7",
"sidebartextcolor": "black",
"sidebarlinkcolor": "#000099",
"footerbgcolor": "white",
"footertextcolor": "#000099",
"textcolor": "black",
"codebgcolor": "#ffffa7",
"linkcolor": "#005ce6",
todo_include_todos = True
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'': None}
autodoc_member_order = 'groupwise'
SEAMAero Documentation
.. toctree::
:maxdepth: 2
Package Metadata
- **classifier**::
Intended Audience :: Science/Research
Topic :: Scientific/Engineering
- **description-file:** README.txt
- **keywords:** openmdao
- **name:** SEAMAero
- **requires-dist:** openmdao.main
- **requires-python**::
- **static_path:** [ '_static' ]
- **version:** 0.1
.. _SEAMAero_src_label:
Source Documentation
.. index::
.. automodule:: SEAMAero.SEAMAero
\ No newline at end of file
Usage Guide
No usage information has been provided for this plugin. Consult the
:ref:`SEAMAero_src_label` section for more detail.
name = SEAMAero
version = 0.1
summary =
description-file = README.txt
keywords = openmdao
home-page =
download-url =
author =
author-email =
maintainer =
maintainer-email =
license =
classifier = Intended Audience :: Science/Research
Topic :: Scientific/Engineering
requires-dist = openmdao.main
provides-dist =
obsoletes-dist =
requires-python =
requires-externals =
project-url =
copyright =
static_path = [ '_static' ]
# This file is autogenerated during plugin quickstart and overwritten during
# plugin makedist. DO NOT CHANGE IT if you plan to use plugin makedist to update
# the distribution.
from setuptools import setup, find_packages
kwargs = {'author': '',
'author_email': '',
'classifiers': ['Intended Audience :: Science/Research',
'Topic :: Scientific/Engineering'],
'description': '',
'download_url': '',
'include_package_data': True,
'install_requires': ['openmdao.main'],
'keywords': ['openmdao'],
'license': '',
'maintainer': '',
'maintainer_email': '',
'name': 'SEAMAero',
'package_data': {'SEAMAero': []},
'package_dir': {'': 'src'},
'packages': ['SEAMAero'],
'url': '',
'version': '0.1',
'zip_safe': False}
__all__ = ['SEAMAero']
from openmdao.main.api import Component
from openmdao.lib.datatypes.api import Float
# Make sure that your class has some kind of docstring. Otherwise
# the descriptions for your variables won't show up in the
# source ducumentation.
class SEAMAero(Component):
# declare inputs and outputs here, for example:
#x = Float(0.0, iotype='in', desc='description for x')
#y = Float(0.0, iotype='out', desc='description for y')
def execute(self):
""" do your calculations here """
\ No newline at end of file
\ No newline at end of file
import unittest
class SEAMAeroTestCase(unittest.TestCase):
def setUp(self):
def tearDown(self):
# add some tests here...
#def test_SEAMAero(self):
if __name__ == "__main__":
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment