1. 11 Aug, 2021 1 commit
    • Josh A. Mitchell's avatar
      Move to actively maintained dependencies for API docs (#3201) · ae2fe2fd
      Josh A. Mitchell authored
      * Proof of concept matching current behaviour with Breathe
      
      * Reorganise C++ API docs to work without autosummary
      
      * Revert to Sphinx-native search
      
      * Move remaining pip deps to conda
      
      * Remove unnecessary lunrsearch templates
      
      * Remove lunrsearch from cmake
      
      * Tidy up layout of API docs
      
      * Get code blocks to work with Breathe
      
      Breathe doesn't seem to support the Doxygen <preformatted> tag.
      It does support the <code> tag, but better yet it supports using
      <verbatim> tags to embed rst into docstrings. This commit changes
      all <pre> tags to use RST verbatim, and updates the Python
      documentation machinery to support it too.
      
      * Clarified some language
      
      * Have doxygen exclude undocumented classes and have sphinx fail on warnings for C++ API docs
      
      * List custom forces and integrators last
      
      * Add breathe to documentation CI
      
      * Typo
      
      * Fix link to custom forces in extras.rst
      
      * Have Breathe process only public classes
      
      * Strip OpenMM:: prefix from rst files to avoid colons in links
      
      * Remove existing private classes from EXCLUDE_SYMBOLS
      
      * Add comment to C++ cmake describing why we promote warnings to errors
      
      * Revise documentation build instructions for new dependencies
      ae2fe2fd
  2. 21 Mar, 2019 1 commit
  3. 06 Dec, 2017 1 commit
  4. 12 Jul, 2016 1 commit
  5. 03 Nov, 2015 1 commit
    • Robert McGibbon's avatar
      Improve docstrings · 98d053d4
      Robert McGibbon authored
      Swigged python docstrings now include documented return values and type
      information or their arguments. They are generated in numpydoc format.
      Furthermore, all of the Python app layer docstrings have been changed
      to numpydoc format. The filterPythonFiles.py script which helps to
      generate the Doxygen Python API docs has been updated to reflect these
      changes.
      98d053d4
  6. 24 Sep, 2015 1 commit
  7. 06 May, 2015 1 commit
  8. 19 Mar, 2015 1 commit
  9. 13 Feb, 2015 1 commit
  10. 30 Dec, 2014 2 commits
    • Jason Swails's avatar
      Fix up some of the documentation and add the usesPeriodicBoundaryConditions to · 1b44cb9e
      Jason Swails authored
      the barostats and andersen thermostat.
      1b44cb9e
    • Jason Swails's avatar
      Add a usesPeriodicBoundaryConditions() method to all of the Force classes and · ddbd992b
      Jason Swails authored
      the System. The System inspects all of its forces and calls
      usePeriodicBoundaryConditions -- it reports 'true' if at least one of its Forces
      returns 'true' for usesPeriodicBoundaryConditions.
      
      The default Force implementation is to raise an exception (NotImplementedError).
      The System implementation will return true if at least one of its Forces returns
      'true' for usesPeriodicBoundaryConditions, _regardless_ of whether or not one or
      more of the forces does not implement the method. If at least one of the forces
      does not implement usesPeriodicBoundaryConditions and all forces return false,
      an OpenMMException is thrown.
      ddbd992b
  11. 31 Jan, 2014 1 commit
  12. 27 Jan, 2014 1 commit
  13. 23 Jan, 2014 2 commits
  14. 15 Apr, 2013 1 commit
  15. 21 Dec, 2012 1 commit
  16. 07 Jun, 2012 1 commit
  17. 07 May, 2012 1 commit
  18. 11 Oct, 2010 1 commit
  19. 30 Sep, 2010 1 commit
  20. 05 May, 2010 1 commit
  21. 16 Apr, 2010 1 commit
  22. 06 Jan, 2010 1 commit
  23. 05 Jan, 2010 2 commits
  24. 18 Dec, 2009 1 commit
  25. 11 Dec, 2009 2 commits
  26. 25 Nov, 2009 2 commits
  27. 24 Nov, 2009 1 commit
  28. 19 Nov, 2009 1 commit
  29. 17 Nov, 2009 1 commit
  30. 11 Nov, 2009 1 commit
  31. 03 Nov, 2009 1 commit
  32. 12 Sep, 2009 1 commit
  33. 21 Aug, 2009 1 commit
  34. 20 Aug, 2009 1 commit
  35. 03 Aug, 2009 1 commit