doc changes for 1.0

jgarman · jgarman · commit ce7754faff79 · 2016-11-22T08:32:34.000-05:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -209,22 +209,6 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'CarbonBlackAPI-PythonBindingsdoc'
 
-# -- 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]).
@@ -289,3 +273,21 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+latex_elements = {
+    # Additional stuff for the LaTeX preamble.
+    # 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',
+    'preamble': "".join((
+        '\DeclareUnicodeCharacter{25A0}{=}',  # Solid box
+    )),
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -142,8 +142,8 @@ The possible options for each credential profile are:
 Future versions of cbapi will also provide the ability to "pin" the TLS certificate so as to provide certificate
 verification on self-signed or internal CA signed certificates.
 
-Backwards Compatibility
------------------------
+Backwards & Forwards Compatibility
+----------------------------------
 
 The previous versions (0.8.x and earlier) of cbapi and bit9Api are now deprecated and will no longer receive updates.
 However, existing scripts will work without change as cbapi includes both in its legacy package.
@@ -160,12 +160,7 @@ New scripts should use the :py:mod:`cbapi.response.rest_api.CbResponseAPI`
 (for Cb Response) and :py:mod:`cbapi.protection.rest_api.CbProtectionAPI`
 (for Cb Protection) API entry points.
 
-
-Forwards Compatibility
-----------------------
-
-*The new API is still in development and may change subtly during the 0.9 release process.* Any breaking changes
-will be documented in the changelog. The API will be frozen as of version 1.0; afterward, any changes in the 1.x version branch
+The API is frozen as of version 1.0; afterward, any changes in the 1.x version branch
 will be additions/bug fixes only. Breaking changes to the API will increment the major version number (2.x).
 
 User Guide
