Code

Convert docstrings to numpydoc style#140

Code

Merged

rocco8773 merged 43 commits intoBaPSF:masterBaPSF/bapsflib:masterfrom rocco8773:docs_convert_2_numpydocrocco8773/bapsflib:docs_convert_2_numpydocCopy head branch name to clipboardJul 9, 2024

+1,949-1,215

Commits

Commits on Jul 3, 2024

• add numpydoc dependency

  rocco8773

  committed
  4d6a9a8

  Copy full SHA for 4d6a9a8

• add numpydoc extension to conf.py

  rocco8773

  committed
  96b69e2

  Copy full SHA for 96b69e2

• fix typo

  rocco8773

  committed
  e0f9007

  Copy full SHA for e0f9007

• convert docstrings to numpydoc style

  rocco8773

  committed
  28b4642

  Copy full SHA for 28b4642

• configure numpydoc to not show inherited members by default

  rocco8773

  committed
  14e6bd8

  Copy full SHA for 14e6bd8

• configure numpydoc to not show inherited members by default

  rocco8773

  committed
  a142653

  Copy full SHA for a142653

• move examples to the __init__ docstring

  rocco8773

  committed
  84aad81

  Copy full SHA for 84aad81

• it's note plural !

  rocco8773

  committed
  3623900

  Copy full SHA for 3623900

• use sphinx.ext.napoleon instead of numpydoc

  rocco8773

  committed
  80ccda5

  Copy full SHA for 80ccda5

• remove vestiges of the numpy extension

  rocco8773

  committed
  c06deec

  Copy full SHA for c06deec

Commits on Jul 4, 2024

• convert docstrings to numpydoc style

  rocco8773

  committed
  22e4a83

  Copy full SHA for 22e4a83

• indent docstring code block

  rocco8773

  committed
  5c8dcae

  Copy full SHA for 5c8dcae

• convert docstrings to numpydoc style

  rocco8773

  committed
  921eea6

  Copy full SHA for 921eea6

• convert docstrings to numpydoc style

  rocco8773

  committed
  28b7e3a

  Copy full SHA for 28b7e3a

• fix typo

  rocco8773

  committed
  431bfaa

  Copy full SHA for 431bfaa

Commits on Jul 8, 2024

• convert docstrings to numpydoc style

  rocco8773

  committed
  4b2979b

  Copy full SHA for 4b2979b

• convert docstrings to numpydoc style

  rocco8773

  committed
  32ea81f

  Copy full SHA for 32ea81f

• convert docstrings to numpydoc style

  rocco8773

  committed
  1a7ff17

  Copy full SHA for 1a7ff17

• convert docstrings to numpydoc style

  rocco8773

  committed
  7788eca

  Copy full SHA for 7788eca

• fix typo

  rocco8773

  committed
  fdd5d6b

  Copy full SHA for fdd5d6b

• fix line length issues

  rocco8773

  committed
  29cbadb

  Copy full SHA for 29cbadb

• convert docstrings to numpydoc style

  rocco8773

  committed
  4be6389

  Copy full SHA for 4be6389

• trying to get HDFReadMsi to intersphinx link

  rocco8773

  committed
  266e7cd

  Copy full SHA for 266e7cd

• get return types to intersphinx link

  rocco8773

  committed
  09a99dc

  Copy full SHA for 09a99dc

• get param types to intersphinx link

  rocco8773

  committed
  f16e1fa

  Copy full SHA for f16e1fa

• fix docstring typo errors

  rocco8773

  committed
  fb34000

  Copy full SHA for fb34000

• convert docstrings to numpydoc style

  rocco8773

  committed
  c26c4ac

  Copy full SHA for c26c4ac

• convert docstrings to numpydoc style

  rocco8773

  committed
  db09c0d

  Copy full SHA for db09c0d

• convert docstrings to numpydoc style

  rocco8773

  committed
  5aa032e

  Copy full SHA for 5aa032e

• trying to break the .. note:: from the Returns section

  rocco8773

  committed
  a785046

  Copy full SHA for a785046

• convert docstring to numpydoc style

  rocco8773

  committed
  3809105

  Copy full SHA for 3809105

• convert docstring to numpydoc style

  rocco8773

  committed
  3f4a566

  Copy full SHA for 3f4a566

• convert docstring to numpydoc style

  rocco8773

  committed
  c8245fe

  Copy full SHA for c8245fe

• convert docstring to numpydoc style

  rocco8773

  committed
  1deea61

  Copy full SHA for 1deea61

• convert docstring to numpydoc style

  rocco8773

  committed
  c9f0821

  Copy full SHA for c9f0821

• convert docstring to numpydoc style

  rocco8773

  committed
  6b5a95f

  Copy full SHA for 6b5a95f

• convert docstring to numpydoc style

  rocco8773

  committed
  4add26b

  Copy full SHA for 4add26b

Commits on Jul 9, 2024

• convert docstring to numpydoc style, :code: -> ``

  rocco8773

  committed
  8af449f

  Copy full SHA for 8af449f

• add changelog entries

  rocco8773

  committed
  27d4185

  Copy full SHA for 27d4185

• appease grumpy black

  rocco8773

  committed
  6287252

  Copy full SHA for 6287252

• appease grumpy codespell

  rocco8773

  committed
  c08d7bf

  Copy full SHA for c08d7bf

• add numpydoc to intersphinx mappings

  rocco8773

  committed
  e56b22c

  Copy full SHA for e56b22c

• replace double backslashes with single backslashes

  rocco8773

  committed
  aa9924c

  Copy full SHA for aa9924c