python-packaging-tutorial · ChrisBarker-NOAA · Jul 9, 2018 · Jul 6, 2018 · Jul 8, 2018 · Jul 9, 2018
diff --git a/sphinx_presentation/.gitignore b/sphinx_presentation/.gitignore
@@ -0,0 +1,4 @@
+.DS_Store
+
+
+
diff --git a/sphinx_presentation/2018-AnacondaCON-PackageBuilding.pptx b/sphinx_presentation/2018-AnacondaCON-PackageBuilding.pptx
diff --git a/sphinx_presentation/Makefile b/sphinx_presentation/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = TheJoyofPackaging
+SOURCEDIR     = source
+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)
diff --git a/sphinx_presentation/make.bat b/sphinx_presentation/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=TheJoyofPackaging
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/sphinx_presentation/slides2rst.py b/sphinx_presentation/slides2rst.py
@@ -0,0 +1,65 @@
+#!/usr/bin/env python
+
+"""
+hacky script to convert the txt exported from google slides to rst for hieroglyph
+"""
+
+inlines = open("2018-AnacondaCON-PackageBuilding.pptx.txt").readlines()
+outfilename = "PackageBuilding.rst"
+
+rst = []
+
+# first line is the title:
+title = inlines.pop(0).strip()
+rst.append("#" * len(title))
+rst.append(title)
+rst.append("#" * len(title))
+rst.append("")
+# find end of title page:
+line = inlines.pop(0)
+while line.strip() != '1':
+    rst.append(line)
+    line = inlines.pop(0)
+
+while inlines:
+    # look for slide break:
+    slide_num = 0
+    for i, line in enumerate(inlines):
+        # numbers by themselves on a line is a new slide
+        try:
+            num = int(line)
+        except ValueError:
+            continue
+        if num != slide_num:
+            slide_num = num
+            start_ind = i
+        else:
+            # we've hit the second numbers
+            end_ind = i
+            break
+    # write content
+    # slide header is right before slide number
+    header = inlines[start_ind - 1].strip()
+    rst.append(header)
+    rst.append("-" * len(header))
+
+    # content is the stuff above it
+    for line in inlines[:start_ind - 1]:
+        rst.append(line)
+    # footer is the stuff in between
+    rst.append("")
+    for line in inlines[start_ind + 1:end_ind]:
+        rst.append(line)
+    # clear it all out:
+    del inlines[:end_ind + 1]
+    # and clear out any empty lines
+    while inlines and (not inlines[0].strip()):
+        del inlines[0]
+
+
+
+
+
+
+open(outfilename, 'w').write("\n".join(rst))
+
diff --git a/sphinx_presentation/source/conf.py b/sphinx_presentation/source/conf.py
@@ -0,0 +1,160 @@
+# -*- 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 = 'The Joy of Packaging'
+copyright = '2018, Assorted'
+author = 'Assorted'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- 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.githubpages',
+    'hieroglyph',
+]
+
+# 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 = []
+
+# 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 = 'TheJoyofPackagingdoc'
+
+
+# -- 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, 'TheJoyofPackaging.tex', 'The Joy of Packaging Documentation',
+     'Assorted', '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, 'thejoyofpackaging', 'The Joy of Packaging 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, 'TheJoyofPackaging', 'The Joy of Packaging Documentation',
+     author, 'TheJoyofPackaging', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
diff --git a/sphinx_presentation/source/images/about_section.png b/sphinx_presentation/source/images/about_section.png
diff --git a/sphinx_presentation/source/images/req_run_exports.png b/sphinx_presentation/source/images/req_run_exports.png
diff --git a/sphinx_presentation/source/images/run_exports.png b/sphinx_presentation/source/images/run_exports.png
diff --git a/sphinx_presentation/source/index.rst b/sphinx_presentation/source/index.rst
@@ -0,0 +1,22 @@
+.. The Joy of Packaging documentation master file, created by
+   sphinx-quickstart on Fri Jul  6 14:55:10 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to The Joy of Packaging's documentation!
+================================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   overview
+   package_building
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`