search

mphowardlab / azplugins

A HOOMD-blue component for soft matter simulations.
BSD 3-Clause "New" or "Revised" License
21 stars 13 forks source link

Support read the docs #55

Closed mphoward closed 2 years ago

mphoward commented 2 years ago

This pull request cleans up the documentation and supports builds on read the docs. Dependencies are managed via conda.

Resolves #1

mphoward commented 2 years ago

I've added the RTD build as a required merge item. You can review the docs by clicking on "Details" above.

mphoward commented 2 years ago

When I attempt to compile the documentation locally (make html in the "doc" folder), I do get a bunch of warnings like these:

  • WARNING: toctree contains reference to document 'api/variant' that doesn't have a title: no link will be generated
  • WARNING: autodoc: failed to import module 'analyze' from module 'azplugins'; the following exception was raised: cannot import name '_hoomd' from partially initialized module 'hoomd' (most likely due to a circular import)

I'm not sure if this is just a problem on my end or not.

documenting offline discussion for completeness: these issues were caused by having another version of HOOMD found on the PYTHONPATH. Solution is to make sure you have a compiled HOOMD available, e.g., from the conda environment.