search

mal-lang / mal-toolbox

Apache License 2.0
4 stars 2 forks source link

Generate Documentation #3

Open andrewbwm opened 1 year ago

andrewbwm commented 1 year ago

Use sphinx to generate the restructured text documentation.

andrewbwm commented 1 month ago

The sphinx documentation is up, but it does not use the docstring in place to generate API documentation.

mrkickling commented 1 month ago

It does use them in one sense, see the attackgraphnode for example: https://mal-lang.org/mal-toolbox/apidocs/maltoolbox.attackgraph.node.html

andrewbwm commented 1 month ago

It does use them in one sense, see the attackgraphnode for example: https://mal-lang.org/mal-toolbox/apidocs/maltoolbox.attackgraph.node.html

Why is it that only the node submodule gets those generated? Is this something you had to do manually or is it an issue with the current structure?

mrkickling commented 1 month ago

That is definitely odd, I don't remember doing it manually. I will dig into it.