backspaces / agentscript

An Agent Based Modeling system (ABM)
http://backspaces.github.io/agentscript/
GNU General Public License v3.0
107 stars 14 forks source link

Documentation js #38

Closed bennlich closed 3 years ago

bennlich commented 3 years ago

This PR replaces jsdoc with documentation.js. I was expecting to write our own theme for documentation.js, but the default theme is actually very good. Importantly, there is now a documentation.yml file, which defines the table of contents.

What I like about documentation.js:

In this PR I also added a few documentation stubs for classes that I think we should aim to document for a first release.

@backspaces let me know what you think!

backspaces commented 3 years ago

I like it! Thanks for digging into this.