1. 12 Aug, 2025 2 commits
    • Emilio Gallicchio's avatar
      Variable distance-based displacements for ATMForce (#4776) · 3645e1ee
      Emilio Gallicchio authored
      
      
      * Variable displacements based on particle positions
      
      * set variable displacements when adding particles
      
      * update documentation
      
      * address compilation error in OpenMMFortranWrapper
      
      * update python API tests
      
      * fix stray 'and'
      
      * addParticle() without arguments add a particle that is not displaced
      
      * pack displacement particles into int4
      
      * put back default displacement removed in error
      
      * ATMForce interface with coordinate transformation objects
      
      * revise variable displacement API
      
      * documentation, formatting, serialization
      
      * Fixed C and Fortran wrappers
      
      * Fixed Python wrappers
      
      * Fixed factory
      
      * Sort files to ensure classes are listed in the correct order
      
      * Converted APIUnits test to new ATMForce API
      
      * write class name
      
      * skip the documentation for forward declarations
      
      * undo 9e91d0b since it does not fix the doc build
      
      * remove temporary doc files for nested classes
      
      * Clean away tabs
      
      ---------
      Co-authored-by: default avatarPeter Eastman <peastman@stanford.edu>
      3645e1ee
    • Peter Eastman's avatar
      Convert C++ types to Python types in API docs (#5036) · 4a956a72
      Peter Eastman authored
      * Convert C++ types to Python types in API docs
      
      * Translate some more types
      
      * Convert return types that are STL containers
      4a956a72
  2. 03 Jan, 2024 1 commit
  3. 01 Nov, 2023 1 commit
  4. 31 May, 2023 1 commit
  5. 14 Mar, 2023 1 commit
  6. 11 Apr, 2022 1 commit
  7. 01 Oct, 2021 1 commit
  8. 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
  9. 09 Feb, 2021 1 commit
  10. 05 Jan, 2021 1 commit
  11. 01 Nov, 2019 1 commit
  12. 30 Sep, 2019 1 commit
  13. 06 Sep, 2017 1 commit
  14. 16 Jun, 2017 1 commit
  15. 05 Jan, 2017 1 commit
  16. 04 Jan, 2017 1 commit
  17. 17 Nov, 2015 1 commit
  18. 07 Nov, 2015 1 commit
  19. 05 Nov, 2015 1 commit
  20. 04 Nov, 2015 1 commit
  21. 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
  22. 28 Oct, 2015 1 commit
  23. 29 Sep, 2015 3 commits
  24. 05 Aug, 2015 1 commit
  25. 08 Jul, 2015 3 commits
  26. 22 Jan, 2014 1 commit
  27. 29 Oct, 2013 1 commit
  28. 22 Jul, 2013 1 commit
  29. 13 Jun, 2013 1 commit
  30. 03 May, 2013 1 commit
  31. 25 Mar, 2013 1 commit
  32. 20 Feb, 2013 1 commit
  33. 29 Aug, 2012 1 commit
  34. 30 Mar, 2012 1 commit
  35. 23 Jan, 2012 1 commit