search

maxitg / SetReplace

C++/Wolfram Language package for exploring set and graph rewriting systems
MIT License
219 stars 46 forks source link

Wolfram Language Documentation #27

Open maxitg opened 5 years ago

maxitg commented 5 years ago

It would be useful to have proper Wolfram Language documentation for the package. Ideally, the build script in Wolfram Language should build that documentation rather than Eclipse.

It is unclear how to manage it in git given that documentation is typically in a form of notebooks. Perhaps, it is possible to generate these notebooks automatically from a set of definition files containing usage, discussion, examples, etc.

These are significantly more details and a much better explanation in #485.

maxitg commented 5 years ago

We should use Function Resource notebooks, but it is still unclear how to integrate that into version control.

maxitg commented 4 years ago

We should use Function Resource notebooks, but it is still unclear how to integrate that into version control.

I take that back. We should not be using resource function notebooks. We should be using the standard Wolfram Language paclet documentation system so that it works the same way as the documentation for built-in functions.

maxitg commented 4 years ago

These are significantly more details and a much better explanation in #485.