Code

Add Python docstrings#1240

Code

Merged

stevengj merged 55 commits intoNanoComp:masterNanoComp/meep:masterfrom RobinD42:python-docstringsRobinD42/meep:python-docstringsCopy head branch name to clipboardJul 3, 2020

+11,921-1,520

Commits

Commits on Jun 5, 2020

• First pass on tool to extract docstrings and add them to the main documentation.

  

  Robin Dunn

  committed
  43da832

  Copy full SHA for 43da832

• Add templates used for building the Python API docs

  

  Robin Dunn

  committed
  7a0eb34

  Copy full SHA for 7a0eb34

• Update docs README with new info

  

  Robin Dunn

  committed
  633a5d6

  Copy full SHA for 633a5d6

• Add link to new API docs. The old is still there for now.

  

  Robin Dunn

  committed
  7189c9b

  Copy full SHA for 7189c9b

• First pass on adding docstrings to the python code.

  

  Robin Dunn

  committed
  71cbaa3

  Copy full SHA for 71cbaa3

• Clarify the note in the README about when to rebuild

  

  Robin Dunn

  committed
  552712e

  Copy full SHA for 552712e

Commits on Jun 15, 2020

• Fix typo

  

  Robin Dunn

  committed
  0304197

  Copy full SHA for 0304197

• Refactor doc generator tool to pull items into the master doc by name, rather than as a collection of all classes found by the scan

  

  Robin Dunn

  committed
  ac2f5fc

  Copy full SHA for ac2f5fc

• Fix typo

  

  Robin Dunn

  committed
  6bbd05d

  Copy full SHA for 6bbd05d

• Use spaces inside the tag markers. It's more readable.

  

  Robin Dunn

  committed
  c50490c

  Copy full SHA for c50490c

• Reorder methods to ensure that __init__ comes first

  

  Robin Dunn

  committed
  ba3aa00

  Copy full SHA for ba3aa00

Commits on Jun 16, 2020

• Look only at items that are in the class, not all inherited members.

  Show description for 051b5ce
  RobinD42

  committed
  051b5ce

  Copy full SHA for 051b5ce

• Move remaining class and method docs to docstrings

  RobinD42

  committed
  d681313

  Copy full SHA for d681313

• Fix typo in Simulation tag

  RobinD42

  committed
  d7c76d6

  Copy full SHA for d7c76d6

• Merge branch 'master' into python-docstrings

  RobinD42

  committed
  920d771

  Copy full SHA for 920d771

• Regenerate document

  RobinD42

  committed
  32ad295

  Copy full SHA for 32ad295

• Copy recent changes from the non-template version of the document

  RobinD42

  committed
  8399555

  Copy full SHA for 8399555

Commits on Jun 18, 2020

• Only load the template files once, and other light refactoring

  RobinD42

  committed
  f45b05e

  Copy full SHA for f45b05e

Commits on Jun 19, 2020

• Add doc generation support for functions

  RobinD42

  committed
  2bf85ea

  Copy full SHA for 2bf85ea

• Continue moving documentation to doctrings

  RobinD42

  committed
  94018b8

  Copy full SHA for 94018b8

Commits on Jun 22, 2020

• Add and export a GDSII_prisms function, for consistency with the other GDSII functions.

  RobinD42

  committed
  894b726

  Copy full SHA for 894b726

• Fix some copy/paste mistakes

  RobinD42

  committed
  0e7213d

  Copy full SHA for 0e7213d

• Expose the DtfFOO classes so their docstrings can be linked to

  RobinD42

  committed
  98e9fd8

  Copy full SHA for 98e9fd8

• Move and link dostrings for GDSII, Run and Step, and Output sections

  RobinD42

  committed
  b023379

  Copy full SHA for b023379

Commits on Jun 23, 2020

• Move remaining documentation snippets to docstrings in the source.

  RobinD42

  committed
  7063b37

  Copy full SHA for 7063b37

• Revert Python_User_Interface.md to avoid merge conflicts later.

  RobinD42

  committed
  0dc7443

  Copy full SHA for 0dc7443

• Word-wrap and other formatting tweaks to help the docstrings be more readable in the code.

  RobinD42

  committed
  e6f6f47

  Copy full SHA for e6f6f47

• More docstring formatting

  RobinD42

  committed
  4215996

  Copy full SHA for 4215996

Commits on Jun 24, 2020

• Typo fix

  RobinD42

  committed
  0ff3a22

  Copy full SHA for 0ff3a22

• Add coding declaration to the top of the Python files.

  Show description for 90ff4a4
  RobinD42

  committed
  90ff4a4

  Copy full SHA for 90ff4a4

• Add a .css file for custom configuration of styles without touching the existing theme files

  RobinD42

  committed
  9a73a36

  Copy full SHA for 9a73a36

• Insert some <div class="..."> tags in the templates

  RobinD42

  committed
  afd02c3

  Copy full SHA for afd02c3

• Add styles

  RobinD42

  committed
  8ff0c8c

  Copy full SHA for 8ff0c8c

• Ignore doc/site and an additional item in tests

  RobinD42

  committed
  264187b

  Copy full SHA for 264187b

• Backslashes in docstrings need to be escaped

  RobinD42

  committed
  ba85661

  Copy full SHA for ba85661

• More template and style tweaks.

  RobinD42

  committed
  5a24ca3

  Copy full SHA for 5a24ca3

Commits on Jun 29, 2020

• Remove the now generated Python_User_Interface.md file

  RobinD42

  committed
  81b46ea

  Copy full SHA for 81b46ea

• Add support for building the documentation via the Makefile

  RobinD42

  committed
  e8f8251

  Copy full SHA for e8f8251

Commits on Jun 30, 2020

• rewrap paragraph

  RobinD42

  committed
  40ea7b4

  Copy full SHA for 40ea7b4

• Set PYTHONPATH and use $(PYTHON)

  RobinD42

  committed
  59a873f

  Copy full SHA for 59a873f

• Convert README to Markdown

  RobinD42

  committed
  9f26ad6

  Copy full SHA for 9f26ad6

• make dist now depends on building the docs, and the docs are included in the dist archive

  RobinD42

  committed
  f2e6020

  Copy full SHA for f2e6020

• More info and clarification in the doc/README.md file

  RobinD42

  committed
  e939784

  Copy full SHA for e939784

• Include generate_py_api.py in the distribution

  RobinD42

  committed
  f4d909f

  Copy full SHA for f4d909f

• Fix building docs when configured in a separate build folder

  RobinD42

  committed
  446581c

  Copy full SHA for 446581c

• Install the docs-related packages on Travis

  RobinD42

  committed
  af97742

  Copy full SHA for af97742

• Python 2.7 mkdocs has broken dependencies, skip building the docs on Python 2.7 builds

  RobinD42

  committed
  3a8e156

  Copy full SHA for 3a8e156

• Python2 does not have f-strings

  RobinD42

  committed
  d8e4e5f

  Copy full SHA for d8e4e5f

• Use Python2-style super()

  RobinD42

  committed
  27707ca

  Copy full SHA for 27707ca

Commits on Jul 1, 2020

• Also skip running the generator on Python2, for now.

  RobinD42

  committed
  98cda7a

  Copy full SHA for 98cda7a

• Move generate_py_api script to the doc folder,

  Show description for ecb7149
  RobinD42

  committed
  ecb7149

  Copy full SHA for ecb7149

• Restore the generated API doc

  RobinD42

  committed
  efab205

  Copy full SHA for efab205

• cleanup

  RobinD42

  committed
  ea3d0f3

  Copy full SHA for ea3d0f3

• Revert including the docs build in the make dist and clean up the doc targets

  RobinD42

  committed
  9858540

  Copy full SHA for 9858540

• Minor tweaks in doc/README.md

  RobinD42

  committed
  2d19a55

  Copy full SHA for 2d19a55