 }})
+
+
+
+
+
+
+ +
\ No newline at end of file diff --git a/docs/_themes/.gitignore b/docs/_themes/.gitignore new file mode 100644 index 0000000..3072e6f --- /dev/null +++ b/docs/_themes/.gitignore @@ -0,0 +1,2 @@ +*.pyc +*.pyo \ No newline at end of file diff --git a/docs/_themes/LICENSE b/docs/_themes/LICENSE new file mode 100644 index 0000000..8756c7a --- /dev/null +++ b/docs/_themes/LICENSE @@ -0,0 +1,37 @@ +Copyright (c) 2010 by Armin Ronacher. + +Some rights reserved. + +Redistribution and use in source and binary forms of the theme, with or +without modification, are permitted provided that the following conditions +are met: + +* Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +* The names of the contributors may not be used to endorse or + promote products derived from this software without specific + prior written permission. + +We kindly ask you to only use these themes in an unmodified manner just +for Flask and Flask-related products, not for unrelated projects. If you +like the visual style and want to use it for your own projects, please +consider making some larger changes to the themes (such as changing +font faces, sizes, colors or margins). + +THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/docs/_themes/flask_theme_support.py b/docs/_themes/flask_theme_support.py new file mode 100644 index 0000000..8a3278e --- /dev/null +++ b/docs/_themes/flask_theme_support.py @@ -0,0 +1,86 @@ +# flasky pygments style based on tango style +from pygments.style import Style +from pygments.token import Keyword, Name, Comment, String, Error, \ + Number, Operator, Generic, Whitespace, Punctuation, Other, Literal + + +class FlaskyStyle(Style): + background_color = "#f8f8f8" + default_style = "" + + styles = { + # No corresponding class for the following: + #Text: "", # class: '' + Whitespace: "underline #f8f8f8", # class: 'w' + Error: "#a40000 border:#ef2929", # class: 'err' + Other: "#000000", # class 'x' + + Comment: "italic #8f5902", # class: 'c' + Comment.Preproc: "noitalic", # class: 'cp' + + Keyword: "bold #004461", # class: 'k' + Keyword.Constant: "bold #004461", # class: 'kc' + Keyword.Declaration: "bold #004461", # class: 'kd' + Keyword.Namespace: "bold #004461", # class: 'kn' + Keyword.Pseudo: "bold #004461", # class: 'kp' + Keyword.Reserved: "bold #004461", # class: 'kr' + Keyword.Type: "bold #004461", # class: 'kt' + + Operator: "#582800", # class: 'o' + Operator.Word: "bold #004461", # class: 'ow' - like keywords + + Punctuation: "bold #000000", # class: 'p' + + # because special names such as Name.Class, Name.Function, etc. + # are not recognized as such later in the parsing, we choose them + # to look the same as ordinary variables. + Name: "#000000", # class: 'n' + Name.Attribute: "#c4a000", # class: 'na' - to be revised + Name.Builtin: "#004461", # class: 'nb' + Name.Builtin.Pseudo: "#3465a4", # class: 'bp' + Name.Class: "#000000", # class: 'nc' - to be revised + Name.Constant: "#000000", # class: 'no' - to be revised + Name.Decorator: "#888", # class: 'nd' - to be revised + Name.Entity: "#ce5c00", # class: 'ni' + Name.Exception: "bold #cc0000", # class: 'ne' + Name.Function: "#000000", # class: 'nf' + Name.Property: "#000000", # class: 'py' + Name.Label: "#f57900", # class: 'nl' + Name.Namespace: "#000000", # class: 'nn' - to be revised + Name.Other: "#000000", # class: 'nx' + Name.Tag: "bold #004461", # class: 'nt' - like a keyword + Name.Variable: "#000000", # class: 'nv' - to be revised + Name.Variable.Class: "#000000", # class: 'vc' - to be revised + Name.Variable.Global: "#000000", # class: 'vg' - to be revised + Name.Variable.Instance: "#000000", # class: 'vi' - to be revised + + Number: "#990000", # class: 'm' + + Literal: "#000000", # class: 'l' + Literal.Date: "#000000", # class: 'ld' + + String: "#4e9a06", # class: 's' + String.Backtick: "#4e9a06", # class: 'sb' + String.Char: "#4e9a06", # class: 'sc' + String.Doc: "italic #8f5902", # class: 'sd' - like a comment + String.Double: "#4e9a06", # class: 's2' + String.Escape: "#4e9a06", # class: 'se' + String.Heredoc: "#4e9a06", # class: 'sh' + String.Interpol: "#4e9a06", # class: 'si' + String.Other: "#4e9a06", # class: 'sx' + String.Regex: "#4e9a06", # class: 'sr' + String.Single: "#4e9a06", # class: 's1' + String.Symbol: "#4e9a06", # class: 'ss' + + Generic: "#000000", # class: 'g' + Generic.Deleted: "#a40000", # class: 'gd' + Generic.Emph: "italic #000000", # class: 'ge' + Generic.Error: "#ef2929", # class: 'gr' + Generic.Heading: "bold #000080", # class: 'gh' + Generic.Inserted: "#00A000", # class: 'gi' + Generic.Output: "#888", # class: 'go' + Generic.Prompt: "#745334", # class: 'gp' + Generic.Strong: "bold #000000", # class: 'gs' + Generic.Subheading: "bold #800080", # class: 'gu' + Generic.Traceback: "bold #a40000", # class: 'gt' + } \ No newline at end of file diff --git a/docs/api.rst b/docs/api.rst index 3bd0f3d..646f905 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,37 +4,42 @@ API Reference ============= +.. module:: camelot + camelot.read_pdf ================ -.. automodule:: camelot.read_pdf - :members: +.. autofunction:: camelot.read_pdf + +camelot.plot_geometry +===================== +.. autofunction:: camelot.plot_geometry camelot.handlers.PDFHandler =========================== -.. automodule:: camelot.handlers.PDFHandler - :members: +.. autoclass:: camelot.handlers.PDFHandler + :inherited-members: camelot.parsers.Stream ====================== -.. automodule:: camelot.parsers.Stream - :members: +.. autoclass:: camelot.parsers.Stream + :inherited-members: camelot.parsers.Lattice ======================= -.. automodule:: camelot.parsers.Lattice - :members: +.. autoclass:: camelot.parsers.Lattice + :inherited-members: camelot.core.Cell ================= -.. automodule:: camelot.core.Cell - :members: +.. autoclass:: camelot.core.Cell + :inherited-members: camelot.core.Table ================== -.. automodule:: camelot.core.Table - :members: +.. autoclass:: camelot.core.Table + :inherited-members: camelot.core.TableList ====================== -.. automodule:: camelot.core.TableList - :members: \ No newline at end of file +.. autoclass:: camelot.core.TableList + :inherited-members: \ No newline at end of file diff --git a/docs/assets/camelot.png b/docs/assets/camelot.png deleted file mode 100644 index ab3466d..0000000 Binary files a/docs/assets/camelot.png and /dev/null differ diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico deleted file mode 100644 index 65f6dd2..0000000 Binary files a/docs/assets/favicon.ico and /dev/null differ diff --git a/docs/conf.py b/docs/conf.py index a23c87a..eecb52f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,6 +23,7 @@ import sys # Insert Camelot's path into the system. sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('_themes')) import camelot @@ -158,13 +159,12 @@ html_theme_options = { # The name of an image file (relative to this directory) to place at the top # of the sidebar. # -html_logo = 'assets/camelot.png' +# html_logo = None # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -# -html_favicon = 'assets/favicon.ico' +html_favicon = '_static/favicon.ico' # 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, @@ -188,8 +188,12 @@ html_static_path = ['_static'] html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -# -# html_sidebars = {} +html_sidebars = { + 'index': ['sidebarlogo.html', 'relations.html', 'sourcelink.html', + 'searchbox.html'], + '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html', + 'sourcelink.html', 'searchbox.html'] +} # Additional templates that should be rendered to pages, maps page names to # template names. @@ -209,7 +213,7 @@ html_use_smartypants = True # html_split_index = False # If true, links to the reST sources are added to the pages. -html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False @@ -352,6 +356,6 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'python': ('https://docs.python.org/2': None), - 'pandas': ('http://pandas.pydata.org/pandas-docs/stable': None) + 'https://docs.python.org/2': None, + 'http://pandas.pydata.org/pandas-docs/stable': None } \ No newline at end of file diff --git a/docs/contributing.rst b/docs/contributing.rst index 928dd33..32067da 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,5 +1,9 @@ .. _contributing: +======================= +Contributing guidelines +======================= + The preferred way to contribute to Camelot is to fork this repository, and then submit a "pull request" (PR): 1. Create an account on GitHub if you don't already have one. diff --git a/docs/index.rst b/docs/index.rst index 4b91c69..b5702ba 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -132,4 +132,14 @@ Testing License ======= -BSD License \ No newline at end of file +MIT License + +Sitemap +======= + +.. toctree:: + + lattice + stream + contributing + api \ No newline at end of file