API docs
documentation
Jakob pointed out it would be useful to have basic docs outlining the main functionality of the repo. I can generate something of this ilk with pdoc, which yields this sort of thing:
<img width="1341" alt="Screenshot 2023-10-16 at 8 58 01 PM" src="https://github.com/JakobRobnik/MicroCanonicalHMC/assets/7295980/1dd8ab8d-36b2-47fb-9f14-c337e4e8ac02">
I need to work out how to automatically serve these docs online (currently I view them locally), and also how to customize them to ignore the less important functionality (and comment on the important stuff). Other than that, it seems like the right tool for doing this without hassle.
关闭于 2023-11-03 2 条评论