some updating (I forgot what)

Author: ChrisBarker-NOAA

Sources/source/conf.py

@@ -269,39 +269,29 @@
 #texinfo_no_detailmenu = False
 
 
-# -- Hieroglyph Slide Configuration ------------
-
-extensions += [
-    'hieroglyph',
-]
-
-slide_title = "PythonTopics"
-slide_theme = 'slides2'
-slide_levels = 3
-
 # Place custom static assets in the _static directory and uncomment
 # the following lines to include them
 
-slide_theme_options = {
-    'subtitle': 'Interesting Corners of Python Programming',
-    'custom_css': 'custom.css',
-    # 'custom_js': 'custom.js',
-    'presenters': [
-        {
-            'name': u'Christopher Barker',
-            'email': u'PythonCHB@gmail.com',
-            'github': u'https://github.com/PythonCHB',
-            'company': u'Christopher Barker, PhD'
-        },
-        # {
-        #     'name': 'Cris Ewing',
-        #     'twitter': '@crisewing',
-        #     'www': 'http://crisewing.com',
-        #     'github': 'http://github.com/cewing',
-        #     'company': 'Cris Ewing, Developer LLC'
-        # },
-    ]
-}
+# slide_theme_options = {
+#     'subtitle': 'Interesting Corners of Python Programming',
+#     'custom_css': 'custom.css',
+#     # 'custom_js': 'custom.js',
+#     'presenters': [
+#         {
+#             'name': u'Christopher Barker',
+#             'email': u'PythonCHB@gmail.com',
+#             'github': u'https://github.com/PythonCHB',
+#             'company': u'Christopher Barker, PhD'
+#         },
+#         # {
+#         #     'name': 'Cris Ewing',
+#         #     'twitter': '@crisewing',
+#         #     'www': 'http://crisewing.com',
+#         #     'github': 'http://github.com/cewing',
+#         #     'company': 'Cris Ewing, Developer LLC'
+#         # },
+#     ]
+# }
 
 # ----------------------------------------------
 

Sources/source/index.rst

@@ -1,32 +1,18 @@
 In This Collection
 ==================
 
-.. ifslides::
+Topics:
+-------
 
-    +-------------------------------+
-    | Topics:                       |
-    +===============================+
-    | .. toctree::                  |
-    |     :maxdepth: 1              |
-    |                               |
-    |     weak_references           |
-    |     persistance_serialization |
-    +-------------------------------+
+.. toctree::
+    :maxdepth: 1
 
-.. ifnotslides::
+    weak_references
+    persistance_serialization
+    where_to_put_tests
+    where_to_put_your_code
+    interfacing_with_c/index
 
-    Topics:
-    -------
-
-    .. toctree::
-        :maxdepth: 1
-
-        weak_references
-        persistance_serialization
-        where_to_put_tests
-        where_to_put_your_code
-
-.. rst-class:: credit
 
 These materials copyright Christopher H. Barker
 

Sources/source/interfacing_with_c/c_python.rst

@@ -12,13 +12,15 @@ Documentation:
 Core docs for the C API:
 
 
+https://docs.python.org/3/extending/
 
 
 Interfacing methods:
 ====================
 
 There a bunch of ways to interface C and Python:
 
+
 Hand write against the C API:
 -----------------------------
 
@@ -35,14 +37,14 @@ Cython can be described as a "python-like language for writing python extensions
 
 It can be used essentially to speed up Python, but also to call Python from C.
 
-(derived from Pyrex)
+https://cython.org/
 
-XDress
-......
 
 ctypes
 ------
 
+Ctypes comes with PYthon out of the box.
+
 
 SWIG, SIP, ETC.
 ---------------
@@ -53,5 +55,9 @@ Auto wrapper generators.
 EXAMPLE:
 ========
 
-Same as the one for fortran: a automatic gain control filter.
+Same as the one for fortran: a automatic gain control filter:
+
+:download:`agc_example.zip`
+
+
 

Sources/source/where_to_put_tests.rst

@@ -18,13 +18,13 @@ Test system recommendations
 
 https://pytest.org/latest/goodpractises.html
 
-I need to add links for ``nose`` and ``unittest``.... PR's accepted!
+I need to add links for ``nose`` and ``unittest`` ... PR's accepted!
 
 
 Two Options
 -----------
 
-In Python packaging, there seems is no consensus on where you should put your test suite. This thread:
+In Python packaging, there is no consensus on where you should put your test suite. This thread:
 
 https://mail.python.org/pipermail/distutils-sig/2015-October/027003.html
 
@@ -50,7 +50,10 @@ https://packaging.python.org/en/latest/
 
 for recommendations.
 
-2) The other options is to put your test code in a sub-package inside your package. In this case, it should be inside your package, and *be* a package itself (i.e. have an ``__init__.py``)::
+In the this case, the directory with all the tests shouls not be a python package -- this is, it should not have a ``__init__.py`` file.
+
+
+2) The other options is to put your test code in a sub-package inside your package. In this case, it should be inside your package, and *be* a python package itself (i.e. have an ``__init__.py``)::
 
     my_package
         __init__.py
@@ -61,7 +64,7 @@ for recommendations.
             test_1.py
             test_2.py
 
-Self contained
+Self Contained
 --------------
 
 The advantage of keeping test code self-contained is that you can have a large suite of tests with sample data and who knows what, and it won't bloat and complicate the installed package (and test code can write to the test dirs, etc. Also, you can then run the test suite against an installed version that may not be exactly the same as the current live code.