Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
bsumlin committed Jul 24, 2017
1 parent 7154c00 commit 6e24e59
Show file tree
Hide file tree
Showing 5 changed files with 233 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/build/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 38 additions & 0 deletions docs/build/source/PyMieScatt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
PyMieScatt package
==================

Submodules
----------

PyMieScatt\.CoreShell module
----------------------------

.. automodule:: PyMieScatt.CoreShell
:members:
:undoc-members:
:show-inheritance:

PyMieScatt\.Inverse module
--------------------------

.. automodule:: PyMieScatt.Inverse
:members:
:undoc-members:
:show-inheritance:

PyMieScatt\.Mie module
----------------------

.. automodule:: PyMieScatt.Mie
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: PyMieScatt
:members:
:undoc-members:
:show-inheritance:
167 changes: 167 additions & 0 deletions docs/build/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# PyMieScatt documentation build configuration file, created by
# sphinx-quickstart on Mon Jul 24 15:45:48 2017.
#
# 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.

# 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('.'))


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

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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.napoleon',
'sphinx.ext.imgmath',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.githubpages']

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

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'PyMieScatt'
copyright = '2017, Benjamin Sumlin'
author = 'Benjamin Sumlin'

# 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 = '1.0.1'
# The full version, including alpha/beta/rc tags.
release = '1.0.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 = []

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

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


# -- 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'

# 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 = {}

# 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']


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

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


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

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'PyMieScatt.tex', 'PyMieScatt Documentation',
'Benjamin Sumlin', 'manual'),
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pymiescatt', 'PyMieScatt Documentation',
[author], 1)
]


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

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PyMieScatt', 'PyMieScatt Documentation',
author, 'PyMieScatt', 'One line description of project.',
'Miscellaneous'),
]




# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
20 changes: 20 additions & 0 deletions docs/build/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. PyMieScatt documentation master file, created by
sphinx-quickstart on Mon Jul 24 15:45:48 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyMieScatt's documentation!
======================================

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



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 7 additions & 0 deletions docs/build/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
PyMieScatt
==========

.. toctree::
:maxdepth: 4

PyMieScatt

0 comments on commit 6e24e59

Please sign in to comment.