Mercurial > pygpibtoolkit / changeset

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/Makefile	Wed May 16 10:53:51 2018 +0200
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pygpibtoolkit
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/_static/pygpibtoolkit.svg	Wed May 16 10:53:51 2018 +0200
@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.0"
+   width="214.70084"
+   height="131.73161"
+   id="svg9986"
+   sodipodi:docname="pygpibtoolkit.svg"
+   inkscape:version="0.92.1 r15371">
+  <metadata
+     id="metadata8">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1154"
+     inkscape:window-height="1147"
+     id="namedview6"
+     showgrid="false"
+     inkscape:zoom="1.4292387"
+     inkscape:cx="267.34144"
+     inkscape:cy="-50.060903"
+     inkscape:window-x="758"
+     inkscape:window-y="24"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="svg9986"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0" />
+  <defs
+     id="defs9988">
+    <radialGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient2795"
+       id="radialGradient1480"
+       gradientUnits="userSpaceOnUse"
+       gradientTransform="matrix(1.8656602e-8,-0.25594342,1.1249792,4.0443152e-7,-83.316716,158.783)"
+       cx="61.518883"
+       cy="132.28575"
+       fx="61.518883"
+       fy="132.28575"
+       r="29.036913" />
+    <linearGradient
+       id="linearGradient2795">
+      <stop
+         style="stop-color:#b8b8b8;stop-opacity:0.49803922;"
+         offset="0"
+         id="stop2797" />
+      <stop
+         style="stop-color:#7f7f7f;stop-opacity:0;"
+         offset="1"
+         id="stop2799" />
+    </linearGradient>
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient4671"
+       id="linearGradient1475"
+       gradientUnits="userSpaceOnUse"
+       gradientTransform="matrix(0.60004369,0,0,0.60583673,-10.026402,-5.659002)"
+       x1="150.96111"
+       y1="192.35176"
+       x2="112.03144"
+       y2="137.27299" />
+    <linearGradient
+       id="linearGradient4671">
+      <stop
+         style="stop-color:#ffd43b;stop-opacity:1;"
+         offset="0"
+         id="stop4673" />
+      <stop
+         style="stop-color:#ffe873;stop-opacity:1"
+         offset="1"
+         id="stop4675" />
+    </linearGradient>
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient4689"
+       id="linearGradient1478"
+       gradientUnits="userSpaceOnUse"
+       gradientTransform="matrix(0.60004369,0,0,0.60583673,-10.026402,-5.659002)"
+       x1="26.648937"
+       y1="20.603781"
+       x2="135.66525"
+       y2="114.39767" />
+    <linearGradient
+       id="linearGradient4689">
+      <stop
+         style="stop-color:#5a9fd4;stop-opacity:1;"
+         offset="0"
+         id="stop4691" />
+      <stop
+         style="stop-color:#306998;stop-opacity:1;"
+         offset="1"
+         id="stop4693" />
+    </linearGradient>
+  </defs>
+  <path
+     inkscape:connector-curvature="0"
+     id="path2555"
+     style="fill:#000000;fill-rule:nonzero;stroke:none"
+     d="m 199.7315,131.73162 h -87.24611 l 3.27371,-8.98508 c 37.63886,-2.27929 54.18342,-33.643551 54.18342,-57.879551 0,-25.661665 -20.5311,-55.177853 -57.88836,-55.890687 L 115.19588,0 h 86.25169 c 6.83783,0 13.25326,6.415415 13.25326,12.399621 V 113.47982 c 0,11.83639 -4.69936,18.2518 -14.96933,18.2518 z m -116.4719,0 H 14.96931 C 4.69936,131.73162 0,125.31621 0,113.47982 V 12.399621 C 0,6.415415 6.41541,0 13.25326,0 h 72.42643 l -2.99211,8.835506 c -21.66632,8.553881 -38.35169,30.369818 -38.35169,56.031483 0,24.236 14.25648,47.759191 42.34703,57.025911 z"
+     sodipodi:nodetypes="sccsccsssscssssccscc" />
+  <path
+     style="fill:url(#linearGradient1478);fill-opacity:1;stroke-width:1.0666666"
+     d="m 106.41678,20.045278 c -3.74613,0.01741 -7.3236,0.336899 -10.4714,0.893901 C 86.67232,22.577422 84.9887,26.006403 84.9887,32.33003 v 8.351587 h 21.91334 V 43.46548 H 84.9887 76.764814 c -6.36863,0 -11.945185,3.827912 -13.689455,11.109911 -2.011998,8.346856 -2.101245,13.555435 0,22.2709 1.557677,6.487458 5.277628,11.109918 11.646251,11.109918 h 7.534307 V 77.94451 c 0,-7.232852 6.258033,-13.612829 13.689463,-13.612829 h 21.88779 c 6.09279,0 10.95667,-5.016604 10.95667,-11.135452 V 32.33003 c 0,-5.93864 -5.00991,-10.399716 -10.95667,-11.390851 -3.76438,-0.62663 -7.67025,-0.911308 -11.41639,-0.893901 z m -11.85057,6.717027 c 2.2635,0 4.11194,1.878639 4.11194,4.188564 0,2.301737 -1.84844,4.163023 -4.11194,4.163023 -2.27161,0 -4.11194,-1.861287 -4.11194,-4.163023 0,-2.309925 1.84033,-4.188564 4.11194,-4.188564 z"
+     id="path1948"
+     inkscape:connector-curvature="0" />
+  <path
+     style="fill:url(#linearGradient1475);fill-opacity:1;stroke-width:1.0666666"
+     d="m 131.52262,43.46548 v 9.730749 c 0,7.544118 -6.39594,13.893775 -13.68945,13.893775 H 95.94538 c -5.99544,0 -10.95668,5.131284 -10.95668,11.135448 v 20.866197 c 0,5.938651 5.16406,9.431691 10.95668,11.135451 6.93652,2.03961 13.58829,2.40823 21.88779,0 5.51678,-1.59728 10.95667,-4.81183 10.95667,-11.135451 v -8.35158 h -21.8878 v -2.78386 h 21.8878 10.95669 c 6.36861,0 8.74182,-4.44226 10.95665,-11.109918 2.28784,-6.864248 2.19049,-13.465335 0,-22.2709 -1.57391,-6.340008 -4.57994,-11.109911 -10.95665,-11.109911 z m -12.31028,52.842309 c 2.27161,0 4.11194,1.86129 4.11194,4.163031 0,2.30991 -1.84034,4.18856 -4.11194,4.18856 -2.2635,0 -4.11194,-1.87865 -4.11194,-4.18856 0,-2.301741 1.84844,-4.163031 4.11194,-4.163031 z"
+     id="path1950"
+     inkscape:connector-curvature="0" />
+  <ellipse
+     style="opacity:0.44382025;fill:url(#radialGradient1480);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:16.4452076;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+     id="path1894"
+     cx="107.1507"
+     cy="124.41193"
+     rx="29.365696"
+     ry="5.6942501" />
+</svg>

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/conf.py	Wed May 16 10:53:51 2018 +0200
@@ -0,0 +1,166 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pygpibtoolkit'
+copyright = '2018, David Douard'
+author = 'David Douard'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- 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.todo',
+    'sphinx.ext.viewcode',
+]
+
+# 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'
+
+# 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 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'
+
+
+# -- 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 = 'alabaster'
+
+# 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']
+
+# 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 = 'pygpibtoolkitdoc'
+
+
+# -- 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, 'pygpibtoolkit.tex', 'pygpibtoolkit Documentation',
+     'David Douard', '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, 'pygpibtoolkit', 'pygpibtoolkit 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, 'pygpibtoolkit', 'pygpibtoolkit Documentation',
+     author, 'pygpibtoolkit', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst	Wed May 16 10:53:51 2018 +0200
@@ -0,0 +1,22 @@
+.. pygpibtoolkit documentation master file, created by
+   sphinx-quickstart on Wed May 16 10:51:57 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pygpibtoolkit's documentation!
+=========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction
+   developer_manual
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`