python-openxml · scanny · Nov 15, 2017 · Aug 25, 2018 · Jul 13, 2019 · Aug 25, 2018
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 /dist/
 /docs/.build/
 /*.egg-info
+.pytest_cache/
 *.pyc
 .pytest_cache/
 _scratch/

diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 # 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.
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 from docx import __version__  # noqa
 
@@ -31,28 +31,28 @@
 # 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.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'python-docx'
-copyright = u'2013, Steve Canny'
+project = u"python-docx"
+copyright = u"2013, Steve Canny"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -77,6 +77,10 @@
 
 .. |_Body| replace:: :class:`._Body`
 
+.. |Bookmark| replace:: :class:`.Bookmark`
+
+.. |Bookmarks| replace:: :class:`.Bookmarks`
+
 .. |_Cell| replace:: :class:`._Cell`
 
 .. |_CharacterStyle| replace:: :class:`._CharacterStyle`
@@ -89,6 +93,8 @@
 
 .. |_Columns| replace:: :class:`._Columns`
 
+.. |CommentsPart| replace:: :class:`.CommentsPart`
+
 .. |CoreProperties| replace:: :class:`.CoreProperties`
 
 .. |datetime| replace:: :class:`.datetime.datetime`
@@ -101,6 +107,8 @@
 
 .. |Emu| replace:: :class:`.Emu`
 
+.. |EndnotesPart| replace:: :class:`.EndnotesPart`
+
 .. |False| replace:: :class:`False`
 
 .. |float| replace:: :class:`.float`
@@ -111,6 +119,8 @@
 
 .. |FooterPart| replace:: :class:`.FooterPart`
 
+.. |FootnotesPart| replace:: :class:`.FootnotesPart`
+
 .. |_Header| replace:: :class:`._Header`
 
 .. |HeaderPart| replace:: :class:`.HeaderPart`
@@ -193,7 +203,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['.build']
+exclude_patterns = [".build"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -211,7 +221,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -221,15 +231,15 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'armstrong'
+html_theme = "armstrong"
 
 # 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 themes here, relative to this directory.
-html_theme_path = ['_themes']
+html_theme_path = ["_themes"]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -250,7 +260,7 @@
 # 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']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -263,8 +273,7 @@
 # Custom sidebar templates, maps document names to template names.
 # html_sidebars = {}
 html_sidebars = {
-    '**': ['localtoc.html', 'relations.html', 'sidebarlinks.html',
-           'searchbox.html']
+    "**": ["localtoc.html", "relations.html", "sidebarlinks.html", "searchbox.html"]
 }
 
 # Additional templates that should be rendered to pages, maps page names to
@@ -298,18 +307,16 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'python-docxdoc'
+htmlhelp_basename = "python-docxdoc"
 
 
 # -- 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': '',
 }
@@ -321,8 +328,7 @@
 #  author,
 #  documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'python-docx.tex', u'python-docx Documentation',
-     u'Steve Canny', 'manual'),
+    ("index", "python-docx.tex", u"python-docx Documentation", u"Steve Canny", "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -351,8 +357,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'python-docx', u'python-docx Documentation',
-     [u'Steve Canny'], 1)
+    ("index", "python-docx", u"python-docx Documentation", [u"Steve Canny"], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -365,9 +370,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'python-docx', u'python-docx Documentation',
-     u'Steve Canny', 'python-docx', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        "index",
+        "python-docx",
+        u"python-docx Documentation",
+        u"Steve Canny",
+        "python-docx",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -381,4 +392,4 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/3/': None}
+intersphinx_mapping = {"http://docs.python.org/3/": None}