Create a documentation generation system

fkling / JSNetworkX

Build, process and analyze graphs in JavaScript (port of NetworkX)

https://felix-kling.de/jsnetworkx/

Other

761 stars 184 forks source link

Create a documentation generation system #28

Closed fkling closed 9 years ago

fkling commented 9 years ago

Current idea: Run a separate site/service that automatically rebuilds the documentation after pushing to GitHub.

The service will just be a React site that gets the API information from a JSON blob. The plan is to generate documentation for master and different versions (minor versions before 1.0). E.g. now we would only have master. When v0.3 is released, we will have master and the latest v0.3.x. tag.

I will probably create a new repo for that.

fkling commented 9 years ago

I'm currently working on this. I think it only makes sense to move forward with some proper API documentation in place.