Start using vale and move docs source (pyvista#4118)

* rename and modify * add in google style guide * remove warnings file * revert and update to Google style guide * Add newlines-at-end-of-files --------- Co-authored-by: Andras Deak <[email protected]>
Onandon11 · Mar 15, 2023 · 2b6c604 · 2b6c604
1 parent 50c5eda
commit 2b6c604
Show file tree

Hide file tree

Showing 161 changed files with 828 additions and 58 deletions.
diff --git a/.gitignore b/.gitignore
@@ -57,18 +57,18 @@ htmlcov
 tests/ERROR_OUTPUT.txt
 
 # Sphinx-gallery autogenerated pages
-doc/examples/
-doc/errors.txt
-doc/images/auto-generated
-doc/images/charts
+doc/source/examples/
+doc/source/errors.txt
+doc/source/images/auto-generated
+doc/source/images/charts
 **/myscreenshot.png
 api-autogen/
 _autosummary/
-doc/getting-started/external_examples.rst
-doc/api/plotting/charts/pen_line_styles.rst
-doc/api/plotting/charts/plot_color_schemes.rst
-doc/api/plotting/charts/scatter_marker_styles.rst
-doc/api/utilities/colors.rst
+doc/source/getting-started/external_examples.rst
+doc/source/api/plotting/charts/pen_line_styles.rst
+doc/source/api/plotting/charts/plot_color_schemes.rst
+doc/source/api/plotting/charts/scatter_marker_styles.rst
+doc/source/api/utilities/colors.rst
 **/grid.vtu
 
 # flask examples

diff --git a/doc/.vale.ini b/doc/.vale.ini
@@ -0,0 +1,32 @@
+# Core settings
+# =============
+
+# Location of our `styles`
+StylesPath = "styles"
+
+# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
+MinAlertLevel = warning
+
+# By default, `code` and `tt` are ignored.
+IgnoredScopes = code, tt
+
+# By default, `script`, `style`, `pre`, and `figure` are ignored.
+SkippedScopes = script, style, pre, figure
+
+# WordTemplate specifies what Vale will consider to be an individual word.
+WordTemplate = \b(?:%s)\b
+
+# List of Packages to be used for our guidelines
+Packages = Google
+
+# Define the vocabulary
+Vocab = pyvista
+
+[*.{rst}]
+
+# Apply the following styles
+BasedOnStyles = Vale, Google
+
+# Removing Google-specific rule - Not applicable under some circumstances
+Google.WordList = NO
+Google.Colons = NO
diff --git a/doc/Makefile b/doc/Makefile
@@ -8,7 +8,7 @@ SPHINXOPTS    =
 DEFAULTS	  = -w sphinx_warnings.txt -W --keep-going
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = pyvista
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 
@@ -20,24 +20,24 @@ help:
 
 clean:
 	rm -rf $(BUILDDIR)/*
-	rm -rf examples/
+	rm -rf $(SOURCEDIR)/examples/
 	rm -f errors.txt
 	rm -f sphinx_warnings.txt
-	rm -rf images/auto-generated
-	rm -f getting-started/external_examples.rst
-	find . -type d -name "_autosummary" -exec rm -rf {} +
+	rm -rf $(SOURCEDIR)/images/auto-generated
+	rm -f $(SOURCEDIR)/getting-started/external_examples.rst
+	find $(SOURCEDIR) -type d -name "_autosummary" -exec rm -rf {} +
 
 clean-except-examples:
 	rm -rf $(BUILDDIR)/*
 	rm -f errors.txt
 	rm -f sphinx_warnings.txt
-	rm -rf images/auto-generated
-	rm -f getting-started/external_examples.rst
-	find . -type d -name "_autosummary" -exec rm -rf {} +
+	rm -rf $(SOURCEDIR)/images/auto-generated
+	rm -f $(SOURCEDIR)/getting-started/external_examples.rst
+	find $(SOURCEDIR) -type d -name "_autosummary" -exec rm -rf {} +
 
 # remove autosummary files
 clean-autosummary:
-	find . -type d -name "_autosummary" -exec rm -rf {} +
+	find $(SOURCEDIR) -type d -name "_autosummary" -exec rm -rf {} +
 
 # build html docs in parallel using all available CPUs
 # WARNING: this is a resource hog

diff --git a/doc/extras/developer_notes.rst b/doc/extras/developer_notes.rst
diff --git a/doc/_static/cards.css → doc/source/_static/cards.css b/doc/_static/cards.css → doc/source/_static/cards.css
diff --git a/doc/_static/copybutton.css → doc/source/_static/copybutton.css b/doc/_static/copybutton.css → doc/source/_static/copybutton.css
diff --git a/doc/_static/no_search_highlight.css → doc/source/_static/no_search_highlight.css b/doc/_static/no_search_highlight.css → doc/source/_static/no_search_highlight.css
diff --git a/doc/_static/pyvista_banner.png → doc/source/_static/pyvista_banner.png b/doc/_static/pyvista_banner.png → doc/source/_static/pyvista_banner.png
diff --git a/doc/_static/pyvista_banner_small.png → doc/source/_static/pyvista_banner_small.png b/doc/_static/pyvista_banner_small.png → doc/source/_static/pyvista_banner_small.png
diff --git a/doc/_static/pyvista_logo.png → doc/source/_static/pyvista_logo.png b/doc/_static/pyvista_logo.png → doc/source/_static/pyvista_logo.png
diff --git a/doc/_static/pyvista_logo_sm.png → doc/source/_static/pyvista_logo_sm.png b/doc/_static/pyvista_logo_sm.png → doc/source/_static/pyvista_logo_sm.png
diff --git a/doc/_static/pyvista_logo_sm_sq.png → doc/source/_static/pyvista_logo_sm_sq.png b/doc/_static/pyvista_logo_sm_sq.png → doc/source/_static/pyvista_logo_sm_sq.png
diff --git a/doc/_static/summary.css → doc/source/_static/summary.css b/doc/_static/summary.css → doc/source/_static/summary.css
diff --git a/doc/_templates/autosummary/base.rst → doc/source/_templates/autosummary/base.rst b/doc/_templates/autosummary/base.rst → doc/source/_templates/autosummary/base.rst
diff --git a/doc/_templates/autosummary/class.rst → doc/source/_templates/autosummary/class.rst b/doc/_templates/autosummary/class.rst → doc/source/_templates/autosummary/class.rst
diff --git a/doc/_templates/autosummary/module.rst → doc/source/_templates/autosummary/module.rst b/doc/_templates/autosummary/module.rst → doc/source/_templates/autosummary/module.rst
diff --git a/doc/_templates/sponsor.html → doc/source/_templates/sponsor.html b/doc/_templates/sponsor.html → doc/source/_templates/sponsor.html
diff --git a/doc/ads.txt → doc/source/ads.txt b/doc/ads.txt → doc/source/ads.txt
diff --git a/doc/api/core/camera.rst → doc/source/api/core/camera.rst b/doc/api/core/camera.rst → doc/source/api/core/camera.rst
diff --git a/doc/api/core/cells.rst → doc/source/api/core/cells.rst b/doc/api/core/cells.rst → doc/source/api/core/cells.rst
diff --git a/doc/api/core/composite.rst → doc/source/api/core/composite.rst b/doc/api/core/composite.rst → doc/source/api/core/composite.rst
diff --git a/doc/api/core/dataset.rst → doc/source/api/core/dataset.rst b/doc/api/core/dataset.rst → doc/source/api/core/dataset.rst
diff --git a/doc/api/core/filters.rst → doc/source/api/core/filters.rst b/doc/api/core/filters.rst → doc/source/api/core/filters.rst
diff --git a/doc/api/core/grids.rst → doc/source/api/core/grids.rst b/doc/api/core/grids.rst → doc/source/api/core/grids.rst
diff --git a/doc/api/core/helpers.rst → doc/source/api/core/helpers.rst b/doc/api/core/helpers.rst → doc/source/api/core/helpers.rst
diff --git a/doc/api/core/index.rst → doc/source/api/core/index.rst b/doc/api/core/index.rst → doc/source/api/core/index.rst
diff --git a/doc/api/core/lights.rst → doc/source/api/core/lights.rst b/doc/api/core/lights.rst → doc/source/api/core/lights.rst
diff --git a/doc/api/core/misc.rst → doc/source/api/core/misc.rst b/doc/api/core/misc.rst → doc/source/api/core/misc.rst
diff --git a/doc/api/core/objects.rst → doc/source/api/core/objects.rst b/doc/api/core/objects.rst → doc/source/api/core/objects.rst
diff --git a/doc/api/core/pointsets.rst → doc/source/api/core/pointsets.rst b/doc/api/core/pointsets.rst → doc/source/api/core/pointsets.rst
diff --git a/doc/api/examples/index.rst → doc/source/api/examples/index.rst b/doc/api/examples/index.rst → doc/source/api/examples/index.rst
diff --git a/doc/api/index.rst → doc/source/api/index.rst b/doc/api/index.rst → doc/source/api/index.rst
diff --git a/doc/api/plotting/charts/index.rst → doc/source/api/plotting/charts/index.rst b/doc/api/plotting/charts/index.rst → doc/source/api/plotting/charts/index.rst
diff --git a/doc/api/plotting/conv_func.rst → doc/source/api/plotting/conv_func.rst b/doc/api/plotting/conv_func.rst → doc/source/api/plotting/conv_func.rst
diff --git a/doc/api/plotting/index.rst → doc/source/api/plotting/index.rst b/doc/api/plotting/index.rst → doc/source/api/plotting/index.rst
diff --git a/doc/api/plotting/plotting.rst → doc/source/api/plotting/plotting.rst b/doc/api/plotting/plotting.rst → doc/source/api/plotting/plotting.rst
diff --git a/doc/api/plotting/qt_plotting.rst → doc/source/api/plotting/qt_plotting.rst b/doc/api/plotting/qt_plotting.rst → doc/source/api/plotting/qt_plotting.rst
diff --git a/doc/api/plotting/theme.rst → doc/source/api/plotting/theme.rst b/doc/api/plotting/theme.rst → doc/source/api/plotting/theme.rst
diff --git a/doc/api/plotting/trame.rst → doc/source/api/plotting/trame.rst b/doc/api/plotting/trame.rst → doc/source/api/plotting/trame.rst
diff --git a/doc/api/readers/enums.rst → doc/source/api/readers/enums.rst b/doc/api/readers/enums.rst → doc/source/api/readers/enums.rst
diff --git a/doc/api/readers/index.rst → doc/source/api/readers/index.rst b/doc/api/readers/index.rst → doc/source/api/readers/index.rst
diff --git a/...api/utilities/color_table/color_table.rst → ...api/utilities/color_table/color_table.rst b/...api/utilities/color_table/color_table.rst → ...api/utilities/color_table/color_table.rst
diff --git a/doc/api/utilities/geometric.rst → doc/source/api/utilities/geometric.rst b/doc/api/utilities/geometric.rst → doc/source/api/utilities/geometric.rst
diff --git a/doc/api/utilities/index.rst → doc/source/api/utilities/index.rst b/doc/api/utilities/index.rst → doc/source/api/utilities/index.rst
diff --git a/doc/api/utilities/parametric.rst → doc/source/api/utilities/parametric.rst b/doc/api/utilities/parametric.rst → doc/source/api/utilities/parametric.rst
diff --git a/doc/api/utilities/utilities.rst → doc/source/api/utilities/utilities.rst b/doc/api/utilities/utilities.rst → doc/source/api/utilities/utilities.rst
diff --git a/doc/conf.py → doc/source/conf.py b/doc/conf.py → doc/source/conf.py
@@ -255,24 +255,27 @@
 # NOTE: if these are changed, then doc/intersphinx/update.sh
 # must be changed accordingly to keep auto-updated mappings working
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', (None, 'intersphinx/python-objects.inv')),
+    'python': ('https://docs.python.org/3', (None, '../intersphinx/python-objects.inv')),
     'scipy': (
         'https://docs.scipy.org/doc/scipy/',
-        (None, 'intersphinx/scipy-objects.inv'),
+        (None, '../intersphinx/scipy-objects.inv'),
+    ),
+    'numpy': ('https://numpy.org/doc/stable', (None, '../intersphinx/numpy-objects.inv')),
+    'matplotlib': (
+        'https://matplotlib.org/stable',
+        (None, '../intersphinx/matplotlib-objects.inv'),
     ),
-    'numpy': ('https://numpy.org/doc/stable', (None, 'intersphinx/numpy-objects.inv')),
-    'matplotlib': ('https://matplotlib.org/stable', (None, 'intersphinx/matplotlib-objects.inv')),
     'imageio': (
         'https://imageio.readthedocs.io/en/stable',
-        (None, 'intersphinx/imageio-objects.inv'),
+        (None, '../intersphinx/imageio-objects.inv'),
     ),
     'pandas': (
         'https://pandas.pydata.org/pandas-docs/stable',
-        (None, 'intersphinx/pandas-objects.inv'),
+        (None, '../intersphinx/pandas-objects.inv'),
     ),
-    'pytest': ('https://docs.pytest.org/en/stable', (None, 'intersphinx/pytest-objects.inv')),
-    'pyvistaqt': ('https://qtdocs.pyvista.org/', (None, 'intersphinx/pyvistaqt-objects.inv')),
-    'trimesh': ('https://trimsh.org', (None, 'intersphinx/trimesh-objects.inv')),
+    'pytest': ('https://docs.pytest.org/en/stable', (None, '../intersphinx/pytest-objects.inv')),
+    'pyvistaqt': ('https://qtdocs.pyvista.org/', (None, '../intersphinx/pyvistaqt-objects.inv')),
+    'trimesh': ('https://trimsh.org', (None, '../intersphinx/trimesh-objects.inv')),
 }
 intersphinx_timeout = 10
 
@@ -381,7 +384,7 @@ def __repr__(self):
     # convert rst to md for ipynb
     "pypandoc": True,
     # path to your examples scripts
-    "examples_dirs": ["../examples/"],
+    "examples_dirs": ["../../examples/"],
     # path where to save gallery generated examples
     "gallery_dirs": ["examples"],
     # Pattern to search for example files

diff --git a/doc/extras/building_vtk.rst → doc/source/extras/building_vtk.rst b/doc/extras/building_vtk.rst → doc/source/extras/building_vtk.rst
diff --git a/doc/source/extras/developer_notes.rst b/doc/source/extras/developer_notes.rst
@@ -0,0 +1,3 @@
+.. _ref_developer_notes:
+
+.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/extras/docker.rst → doc/source/extras/docker.rst b/doc/extras/docker.rst → doc/source/extras/docker.rst
diff --git a/doc/extras/extending_pyvista.rst → doc/source/extras/extending_pyvista.rst b/doc/extras/extending_pyvista.rst → doc/source/extras/extending_pyvista.rst
diff --git a/doc/extras/flask.rst → doc/source/extras/flask.rst b/doc/extras/flask.rst → doc/source/extras/flask.rst
@@ -18,7 +18,7 @@ Dynamic Example
 Python Application ``app.py``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. literalinclude:: ../../examples_flask/dynamic_ex/app.py
+.. literalinclude:: ../../../examples_flask/dynamic_ex/app.py
 
 
 Ajax Template ``index.html``
@@ -30,7 +30,7 @@ This template returns the ``meshtype`` parameter back to the
 ``get_img`` method in the flask app, which is used to select the type
 of mesh to be plotted.
 
-.. literalinclude:: ../../examples_flask/dynamic_ex/templates/index.html
+.. literalinclude:: ../../../examples_flask/dynamic_ex/templates/index.html
 
 
 Static Example
@@ -44,7 +44,7 @@ Static Example
 Python Application ``app.py``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. literalinclude:: ../../examples_flask/static_ex/app.py
+.. literalinclude:: ../../../examples_flask/static_ex/app.py
 
 
 Ajax Template ``index.html``
@@ -56,4 +56,4 @@ This template returns the ``meshtype`` parameter back to the
 ``get_img`` method in the flask app, which is used to select the type
 of mesh to be plotted.
 
-.. literalinclude:: ../../examples_flask/static_ex/templates/index.html
+.. literalinclude:: ../../../examples_flask/static_ex/templates/index.html
diff --git a/doc/extras/index.rst → doc/source/extras/index.rst b/doc/extras/index.rst → doc/source/extras/index.rst
diff --git a/doc/extras/plot_directive.rst → doc/source/extras/plot_directive.rst b/doc/extras/plot_directive.rst → doc/source/extras/plot_directive.rst
diff --git a/doc/extras/pyinstaller.rst → doc/source/extras/pyinstaller.rst b/doc/extras/pyinstaller.rst → doc/source/extras/pyinstaller.rst
diff --git a/doc/extras/vtk_data.rst → doc/source/extras/vtk_data.rst b/doc/extras/vtk_data.rst → doc/source/extras/vtk_data.rst
diff --git a/doc/getting-started/authors.rst → doc/source/getting-started/authors.rst b/doc/getting-started/authors.rst → doc/source/getting-started/authors.rst
@@ -16,14 +16,14 @@ section, please be sure to head over to the `Contributors Graph`_.
   possible.
 
 
-.. include:: ../../CITATION.rst
+.. include:: ../../../CITATION.rst
 
 
-.. include:: ../../AUTHORS.rst
+.. include:: ../../../AUTHORS.rst
 
 
 
 License
 -------
 
-.. include:: ../../LICENSE
+.. include:: ../../../LICENSE
diff --git a/doc/getting-started/connections.rst → doc/source/getting-started/connections.rst b/doc/getting-started/connections.rst → doc/source/getting-started/connections.rst
diff --git a/doc/getting-started/index.rst → doc/source/getting-started/index.rst b/doc/getting-started/index.rst → doc/source/getting-started/index.rst
diff --git a/doc/getting-started/installation.rst → doc/source/getting-started/installation.rst b/doc/getting-started/installation.rst → doc/source/getting-started/installation.rst
diff --git a/doc/getting-started/why.rst → doc/source/getting-started/why.rst b/doc/getting-started/why.rst → doc/source/getting-started/why.rst
diff --git a/doc/images/external-examples/AeroSandbox.png → .../images/external-examples/AeroSandbox.png b/doc/images/external-examples/AeroSandbox.png → .../images/external-examples/AeroSandbox.png
diff --git a/...mages/external-examples/Duoprism_3-30.gif → ...mages/external-examples/Duoprism_3-30.gif b/...mages/external-examples/Duoprism_3-30.gif → ...mages/external-examples/Duoprism_3-30.gif
diff --git a/...external-examples/anvil_cirrus_plumes.png → ...external-examples/anvil_cirrus_plumes.png b/...external-examples/anvil_cirrus_plumes.png → ...external-examples/anvil_cirrus_plumes.png
diff --git a/...rnal-examples/atmospheric_convection.jpeg → ...rnal-examples/atmospheric_convection.jpeg b/...rnal-examples/atmospheric_convection.jpeg → ...rnal-examples/atmospheric_convection.jpeg
diff --git a/...es/external-examples/coil_field_lines.png → ...es/external-examples/coil_field_lines.png b/...es/external-examples/coil_field_lines.png → ...es/external-examples/coil_field_lines.png
diff --git a/...es/external-examples/damavand_volcano.gif → ...es/external-examples/damavand_volcano.gif b/...es/external-examples/damavand_volcano.gif → ...es/external-examples/damavand_volcano.gif
diff --git a/doc/images/external-examples/discretize.png → ...e/images/external-examples/discretize.png b/doc/images/external-examples/discretize.png → ...e/images/external-examples/discretize.png
diff --git a/doc/images/external-examples/flem.png → doc/source/images/external-examples/flem.png b/doc/images/external-examples/flem.png → doc/source/images/external-examples/flem.png
diff --git a/doc/images/external-examples/forge.png → ...source/images/external-examples/forge.png b/doc/images/external-examples/forge.png → ...source/images/external-examples/forge.png
diff --git a/doc/images/external-examples/geemap.gif → ...ource/images/external-examples/geemap.gif b/doc/images/external-examples/geemap.gif → ...ource/images/external-examples/geemap.gif
diff --git a/...ages/external-examples/geovista_earth.png → ...ages/external-examples/geovista_earth.png b/...ages/external-examples/geovista_earth.png → ...ages/external-examples/geovista_earth.png
diff --git a/doc/images/external-examples/gmsh_model.png → ...e/images/external-examples/gmsh_model.png b/doc/images/external-examples/gmsh_model.png → ...e/images/external-examples/gmsh_model.png
diff --git a/...rnal-examples/grad_descent_visualizer.gif → ...rnal-examples/grad_descent_visualizer.gif b/...rnal-examples/grad_descent_visualizer.gif → ...rnal-examples/grad_descent_visualizer.gif
diff --git a/doc/images/external-examples/nikolov1.gif → ...rce/images/external-examples/nikolov1.gif b/doc/images/external-examples/nikolov1.gif → ...rce/images/external-examples/nikolov1.gif
diff --git a/doc/images/external-examples/nikolov2.gif → ...rce/images/external-examples/nikolov2.gif b/doc/images/external-examples/nikolov2.gif → ...rce/images/external-examples/nikolov2.gif
diff --git a/doc/images/external-examples/nikolov3.gif → ...rce/images/external-examples/nikolov3.gif b/doc/images/external-examples/nikolov3.gif → ...rce/images/external-examples/nikolov3.gif
diff --git a/doc/images/external-examples/omfvista.png → ...rce/images/external-examples/omfvista.png b/doc/images/external-examples/omfvista.png → ...rce/images/external-examples/omfvista.png
diff --git a/doc/images/external-examples/open-foam.png → ...ce/images/external-examples/open-foam.png b/doc/images/external-examples/open-foam.png → ...ce/images/external-examples/open-foam.png
diff --git a/...images/external-examples/optimization.gif → ...images/external-examples/optimization.gif b/...images/external-examples/optimization.gif → ...images/external-examples/optimization.gif
diff --git a/doc/images/external-examples/orvisu.gif → ...ource/images/external-examples/orvisu.gif b/doc/images/external-examples/orvisu.gif → ...ource/images/external-examples/orvisu.gif
diff --git a/...ages/external-examples/ptera_software.gif → ...ages/external-examples/ptera_software.gif b/...ages/external-examples/ptera_software.gif → ...ages/external-examples/ptera_software.gif
diff --git a/doc/images/external-examples/pvgeo.png → ...source/images/external-examples/pvgeo.png b/doc/images/external-examples/pvgeo.png → ...source/images/external-examples/pvgeo.png
diff --git a/doc/images/external-examples/pymeshfix.png → ...ce/images/external-examples/pymeshfix.png b/doc/images/external-examples/pymeshfix.png → ...ce/images/external-examples/pymeshfix.png
diff --git a/doc/images/external-examples/tetgen.png → ...ource/images/external-examples/tetgen.png b/doc/images/external-examples/tetgen.png → ...ource/images/external-examples/tetgen.png
diff --git a/doc/images/external-examples/vessel_vio.png → ...e/images/external-examples/vessel_vio.png b/doc/images/external-examples/vessel_vio.png → ...e/images/external-examples/vessel_vio.png
diff --git a/doc/images/gifs/box-clip.gif → doc/source/images/gifs/box-clip.gif b/doc/images/gifs/box-clip.gif → doc/source/images/gifs/box-clip.gif
diff --git a/doc/images/gifs/documentation.gif → doc/source/images/gifs/documentation.gif b/doc/images/gifs/documentation.gif → doc/source/images/gifs/documentation.gif
diff --git a/doc/images/gifs/dynamic_flask.gif → doc/source/images/gifs/dynamic_flask.gif b/doc/images/gifs/dynamic_flask.gif → doc/source/images/gifs/dynamic_flask.gif
diff --git a/doc/images/gifs/line-widget-streamlines.gif → ...e/images/gifs/line-widget-streamlines.gif b/doc/images/gifs/line-widget-streamlines.gif → ...e/images/gifs/line-widget-streamlines.gif
diff --git a/doc/images/gifs/plane-clip.gif → doc/source/images/gifs/plane-clip.gif b/doc/images/gifs/plane-clip.gif → doc/source/images/gifs/plane-clip.gif
diff --git a/doc/images/gifs/plane-glyph.gif → doc/source/images/gifs/plane-glyph.gif b/doc/images/gifs/plane-glyph.gif → doc/source/images/gifs/plane-glyph.gif
diff --git a/doc/images/gifs/plane-slice-continuous.gif → ...ce/images/gifs/plane-slice-continuous.gif b/doc/images/gifs/plane-slice-continuous.gif → ...ce/images/gifs/plane-slice-continuous.gif
diff --git a/doc/images/gifs/plane-slice.gif → doc/source/images/gifs/plane-slice.gif b/doc/images/gifs/plane-slice.gif → doc/source/images/gifs/plane-slice.gif
diff --git a/doc/images/gifs/scalar-bar-interactive.gif → ...ce/images/gifs/scalar-bar-interactive.gif b/doc/images/gifs/scalar-bar-interactive.gif → ...ce/images/gifs/scalar-bar-interactive.gif
diff --git a/doc/images/gifs/shrink-globe.gif → doc/source/images/gifs/shrink-globe.gif b/doc/images/gifs/shrink-globe.gif → doc/source/images/gifs/shrink-globe.gif
diff --git a/doc/images/gifs/slider-widget-resolution.gif → .../images/gifs/slider-widget-resolution.gif b/doc/images/gifs/slider-widget-resolution.gif → .../images/gifs/slider-widget-resolution.gif
diff --git a/doc/images/gifs/slider-widget-threshold.gif → ...e/images/gifs/slider-widget-threshold.gif b/doc/images/gifs/slider-widget-threshold.gif → ...e/images/gifs/slider-widget-threshold.gif
diff --git a/doc/images/gifs/sphere-widget-a.gif → doc/source/images/gifs/sphere-widget-a.gif b/doc/images/gifs/sphere-widget-a.gif → doc/source/images/gifs/sphere-widget-a.gif
diff --git a/doc/images/gifs/sphere-widget-b.gif → doc/source/images/gifs/sphere-widget-b.gif b/doc/images/gifs/sphere-widget-b.gif → doc/source/images/gifs/sphere-widget-b.gif
diff --git a/doc/images/gifs/sphere-widget-c.gif → doc/source/images/gifs/sphere-widget-c.gif b/doc/images/gifs/sphere-widget-c.gif → doc/source/images/gifs/sphere-widget-c.gif
diff --git a/doc/images/gifs/volume-clip-plane-widget.gif → .../images/gifs/volume-clip-plane-widget.gif b/doc/images/gifs/volume-clip-plane-widget.gif → .../images/gifs/volume-clip-plane-widget.gif
diff --git a/...mages/user-generated/TestCameraModel1.png → ...mages/user-generated/TestCameraModel1.png b/...mages/user-generated/TestCameraModel1.png → ...mages/user-generated/TestCameraModel1.png
diff --git a/doc/images/user-generated/flask_example.png → ...e/images/user-generated/flask_example.png b/doc/images/user-generated/flask_example.png → ...e/images/user-generated/flask_example.png
diff --git a/...es/user-generated/itk_plotting_sphere.png → ...es/user-generated/itk_plotting_sphere.png b/...es/user-generated/itk_plotting_sphere.png → ...es/user-generated/itk_plotting_sphere.png
diff --git a/doc/images/user-generated/joss.png → doc/source/images/user-generated/joss.png b/doc/images/user-generated/joss.png → doc/source/images/user-generated/joss.png
diff --git a/...images/user-generated/notebook_sphere.png → ...images/user-generated/notebook_sphere.png b/...images/user-generated/notebook_sphere.png → ...images/user-generated/notebook_sphere.png
diff --git a/...mages/user-generated/project_to_plane.png → ...mages/user-generated/project_to_plane.png b/...mages/user-generated/project_to_plane.png → ...mages/user-generated/project_to_plane.png
diff --git a/doc/images/user-generated/ray_trace.png → ...ource/images/user-generated/ray_trace.png b/doc/images/user-generated/ray_trace.png → ...ource/images/user-generated/ray_trace.png
diff --git a/doc/index.rst → doc/source/index.rst b/doc/index.rst → doc/source/index.rst
diff --git a/doc/make_external_gallery.py → doc/source/make_external_gallery.py b/doc/make_external_gallery.py → doc/source/make_external_gallery.py
diff --git a/doc/make_tables.py → doc/source/make_tables.py b/doc/make_tables.py → doc/source/make_tables.py
diff --git a/doc/pyvista-binder-config.yml → doc/source/pyvista-binder-config.yml b/doc/pyvista-binder-config.yml → doc/source/pyvista-binder-config.yml
diff --git a/doc/user-guide/data_model.rst → doc/source/user-guide/data_model.rst b/doc/user-guide/data_model.rst → doc/source/user-guide/data_model.rst
diff --git a/doc/user-guide/index.rst → doc/source/user-guide/index.rst b/doc/user-guide/index.rst → doc/source/user-guide/index.rst
diff --git a/doc/user-guide/jupyter/index.rst → doc/source/user-guide/jupyter/index.rst b/doc/user-guide/jupyter/index.rst → doc/source/user-guide/jupyter/index.rst
diff --git a/doc/user-guide/jupyter/ipygany.rst → doc/source/user-guide/jupyter/ipygany.rst b/doc/user-guide/jupyter/ipygany.rst → doc/source/user-guide/jupyter/ipygany.rst
diff --git a/doc/user-guide/jupyter/ipyvtk_plotting.rst → ...ce/user-guide/jupyter/ipyvtk_plotting.rst b/doc/user-guide/jupyter/ipyvtk_plotting.rst → ...ce/user-guide/jupyter/ipyvtk_plotting.rst
diff --git a/doc/user-guide/jupyter/panel.rst → doc/source/user-guide/jupyter/panel.rst b/doc/user-guide/jupyter/panel.rst → doc/source/user-guide/jupyter/panel.rst
diff --git a/doc/user-guide/jupyter/pythreejs.rst → doc/source/user-guide/jupyter/pythreejs.rst b/doc/user-guide/jupyter/pythreejs.rst → doc/source/user-guide/jupyter/pythreejs.rst
diff --git a/doc/user-guide/jupyter/trame.rst → doc/source/user-guide/jupyter/trame.rst b/doc/user-guide/jupyter/trame.rst → doc/source/user-guide/jupyter/trame.rst
diff --git a/doc/user-guide/optional_features.rst → doc/source/user-guide/optional_features.rst b/doc/user-guide/optional_features.rst → doc/source/user-guide/optional_features.rst
diff --git a/doc/user-guide/simple.rst → doc/source/user-guide/simple.rst b/doc/user-guide/simple.rst → doc/source/user-guide/simple.rst
diff --git a/doc/user-guide/themes.rst → doc/source/user-guide/themes.rst b/doc/user-guide/themes.rst → doc/source/user-guide/themes.rst
diff --git a/doc/user-guide/vtk_to_pyvista.rst → doc/source/user-guide/vtk_to_pyvista.rst b/doc/user-guide/vtk_to_pyvista.rst → doc/source/user-guide/vtk_to_pyvista.rst
@@ -6,7 +6,7 @@ Transitioning from VTK to PyVista
 VTK is primarily developed in C++ and uses chained setter and getter
 commands to access data. Instead, PyVista wraps the VTK data types
 into numpy arrays so that users can benefit from its bracket syntax
-and fancy indexing.  This section demonstrates the difference between
+and fancy indexing. This section demonstrates the difference between
 the two approaches in a series of examples.
 
 For example, to hard-code points for a `vtk.vtkImageData`_ data
@@ -41,7 +41,7 @@ structure using VTK Python's bindings, one would write the following:
 
 As you can see, there is quite a bit of boilerplate that goes into
 the creation of a simple `vtk.vtkImageData`_ dataset. PyVista provides
-much more concise syntax that is more "Pythonic". The equivalent code in
+much more concise syntax that is more "Pythonic." The equivalent code in
 PyVista is:
 
 
@@ -57,7 +57,7 @@ PyVista is:
    >>> x, y = np.meshgrid(xi, xi)
    >>> values = 127.5 + (1.0 + np.sin(x/25.0)*np.cos(y/25.0))
 
-   Create the grid.  Note how the values must use Fortran ordering.
+   Create the grid. Note how the values must use Fortran ordering.
 
    >>> grid = pyvista.UniformGrid(dimensions=(300, 300, 1))
    >>> grid.point_data["values"] = values.flatten(order="F")
@@ -80,9 +80,9 @@ Here, PyVista has done several things for us:
 
    Furthermore, since we know the container is for uniformly spaced data,
    pyvista sets the origin and spacing by default to ``(0, 0, 0)`` and
-   ``(1, 1, 1)``. This is another great thing about PyVista and Python!
+   ``(1, 1, 1)``. This is another great thing about PyVista and Python.
    Rather than having to know everything about the VTK library up front,
-   you can get started very easily! Once you get more familiar with it
+   you can get started very easily. Once you get more familiar with it
    and need to do something more complex, you can dive deeper. For
    example, changing the origin and spacing is as simple as:
 
@@ -95,12 +95,12 @@ Here, PyVista has done several things for us:
    directly in dictionary-style fashion. Also, since VTK stores data
    on the heap (linear segments of RAM; a C++ concept), the
    data must be flattened and put in Fortran ordering (which controls
-   how multidimensional data is laid out in physically 1d memory; numpy
+   how multidimensional data is laid out in physically 1D memory; numpy
    uses "C"-style memory layout by default). This is why in our earlier
    example, the first argument to ``SetValue()`` was written as
    ``x*300 + y``. Here, numpy takes care of this for us quite nicely
    and it's made more explicit in the code, following the Python best
-   practice of "Explicit is better than implicit".
+   practice of "Explicit is better than implicit."
 
 Finally, with PyVista, each geometry class contains methods that allow
 you to immediately plot the mesh without also setting up the plot.
@@ -128,7 +128,7 @@ However, with PyVista you only need:
    grid.plot(cpos='xy', show_scalar_bar=False, cmap='coolwarm')
 
 ..
-   This is here so we can generate a plot.  We have to repeat
+   This is here so we can generate a plot. We have to repeat
    everything since jupyter-execute doesn't allow for
    plain text between command blocks.
 
@@ -150,12 +150,12 @@ However, with PyVista you only need:
 .. _vtk.vtkImageData: https://vtk.org/doc/nightly/html/classvtkImageData.html
 
 
-PointSet Construction
+PointSet construction
 ---------------------
 PyVista heavily relies on NumPy to efficiently allocate and access
-VTK's C arrays.  For example, to create an array of points within VTK
+VTK's C arrays. For example, to create an array of points within VTK
 one would normally loop through all the points of a list and supply
-that to a  `vtkPoints`_ class.  For example:
+that to a  `vtkPoints`_ class. For example:
 
 .. jupyter-execute::
 
@@ -205,9 +205,9 @@ Whereas in VTK you would have to do:
    >>> vtk_poly_data = vtk.vtkPolyData()
    >>> vtk_poly_data.SetPoints(vtk_points)
 
-The same goes with assigning face or cell connectivity/topology.  With
+The same goes with assigning face or cell connectivity/topology. With
 VTK you would normally have to loop using ``InsertNextCell`` and
-``InsertCellPoint``.  For example, to create a single cell
+``InsertCellPoint``. For example, to create a single cell
 (triangle) and then assign it to `vtkPolyData`_:
 
 .. jupyter-execute::
@@ -231,11 +231,11 @@ access it (or change it) from the :attr:`faces
 
 .. _vtk_vs_pyvista_object_repr:
 
-Object Representation
+Object representation
 ---------------------
 Both VTK and PyVista provide representations for their objects.
 
-VTK provides a verbose representation (useful for debugging) of their datatypes
+VTK provides a verbose representation (useful for debugging) of their data types
 that can be accessed via :func:`print`, as the ``__repr__``
 (unlike ``__str__``) only provides minimal information about each object:
 
@@ -261,7 +261,7 @@ In this representation we see:
 All other attributes like :attr:`lines <pyvista.PolyData.lines>`,
 :attr:`point_data <pyvista.DataSet.point_data>`, or
 :attr:`cell_data <pyvista.DataSet.cell_data>` can be
-accessed directly from the object.  This approach was chosen to allow
+accessed directly from the object. This approach was chosen to allow
 for a brief summary showing key parts of the :class:`DataSet
 <pyvista.DataSet>` without overwhelming the user.
 
@@ -271,7 +271,7 @@ While most features can, not everything can be simplified without
 losing functionality or performance.
 
 In the :class:`collision <pyvista.PolyDataFilters.collision>` filter,
-we demonstrate how to calculate the collision between two meshes.  For
+we demonstrate how to calculate the collision between two meshes. For
 example:
 
 .. jupyter-execute::
@@ -300,17 +300,17 @@ example:
    pl.show()
 
 Under the hood, the collision filter detects mesh collisions using
-oriented bounding box (OBB) trees.  For a single collision, this filter
+oriented bounding box (OBB) trees. For a single collision, this filter
 is as performant as the VTK counterpart, but when computing multiple
 collisions with the same meshes, as in the :ref:`collision_example`
 example, it is more efficient to use the `vtkCollisionDetectionFilter
 <https://vtk.org/doc/nightly/html/classvtkCollisionDetectionFilter.html>`_,
-as the OBB tree is computed once for each mesh.  In most cases, pure
+as the OBB tree is computed once for each mesh. In most cases, pure
 PyVista is sufficient for most data science, but there are times when
 you may want to use VTK classes directly.
 
 Note that nothing stops you from using VTK classes and then wrapping
-the output with PyVista.  For example:
+the output with PyVista. For example:
 
 .. jupyter-execute::
 

diff --git a/doc/user-guide/what-is-a-mesh.rst → doc/source/user-guide/what-is-a-mesh.rst b/doc/user-guide/what-is-a-mesh.rst → doc/source/user-guide/what-is-a-mesh.rst
diff --git a/doc/styles/.gitignore b/doc/styles/.gitignore
@@ -0,0 +1,4 @@
+*
+!Vocab
+!Vocab/**
+!.gitignore
diff --git a/doc/styles/Google/AMPM.yml b/doc/styles/Google/AMPM.yml
@@ -0,0 +1,9 @@
+extends: existence
+message: "Use 'AM' or 'PM' (preceded by a space)."
+link: 'https://developers.google.com/style/word-list'
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}[AP]M'
+  - '\d{1,2} ?[ap]m'
+  - '\d{1,2} ?[aApP]\.[mM]\.'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		.. _ref_developer_notes:

		.. include:: ../../../CONTRIBUTING.rst