I'm not sure about the current maintenance status of Doxygen in the project, but more and up-to-date, automated api documentation sounds great to me!
It would probably be possible to integrate any generated static html pages into the Inkscape website, along with the other docs (tutorials, man page, keyboard shortcuts, translation status).
@Eduard: Do you know if there is anything that needs to be taken into account, before someone makes a new git branch and starts to work on adding comments and adjusting doxygen settings (or other things)?
Maren
Am 06.11.2017 um 22:32 schrieb matyilona@...173...:
Hi,
for now I've extended the Python modules for extensions, and linked to it from a few pages to make it easier to find, but I'd be interested in documenting the api too.
As for the generator Doxygen might be an option. I haven't used it extensively, but it supports python (with traditional docstring structure, or its own "##" syntax and special commands). It might be easier to integrating into the build process since Inkscape uses Doxygen already.
matyilona
On Mon, Oct 30, 2017 at 10:27:40AM +0200, Mois wrote:
Hi,
I am not sure if that is what you meant, but some proper api documentation would be wonderful! By this I mean commenting the code and then generating documentation from the comments, e.g. using Epydoc http://epydoc.sourceforge.net/ or Sphinx http://www.sphinx-doc.org/en/stable/. Indeed the code is not super huge and complicated, but having a page with a good overview is valuable.
I would be interested in contributing to such a project too. Also have experience with Inkscape and Python.
In addition to now commenting the modules you listed, it would be useful to have commenting guidelines for future extension developers. Other work would be picking one generator, integrating it into the build process, etc.
Cheers, Mois
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot
Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs