Hi,
I wrote an extension a few years ago, and just updated it this weekend. When reading through the docuemntation I saw that you're looking for someone to write/flesh out the extension guide. I'd like to give it a try.
I have experience with with inkscape and python both, not so much with ruby and perl. I have not found any docs for simpletransform, simplestyle, and inkex so I read trough them. They are pretty easy to understand, but it would be nice if there were some deatails about them on the wiki, not just articles using them.
matyilona
Welcome matyilona!
Have you already seen what we have so far, on the website? https://inkscape.org/en/develop/extensions/
Since writing extensions is mostly over my head, I can't judge which contents are complete or which need more "flesh". But others will chime in soon.
I just wanted to say welcome :-)
All best, brynn
-----Original Message----- From: matyilona@...173... Sent: Sunday, October 29, 2017 9:33 AM To: inkscape-docs@lists.sourceforge.net Subject: [Inkscape-docs] Extensions guide
Hi,
I wrote an extension a few years ago, and just updated it this weekend. When reading through the docuemntation I saw that you're looking for someone to write/flesh out the extension guide. I'd like to give it a try.
I have experience with with inkscape and python both, not so much with ruby and perl. I have not found any docs for simpletransform, simplestyle, and inkex so I read trough them. They are pretty easy to understand, but it would be nice if there were some deatails about them on the wiki, not just articles using them.
matyilona
------------------------------------------------------------------------------ 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
Hi matyilona,
some documentation for those main modules would be helpful, indeed.
If you let us know your desired user name / email address for the Wiki, we can provide you with access, so you can start right away, while the info is still fresh in your mind :)
Regards, Maren
Am 29.10.2017 um 17:33 schrieb brynn:
Welcome matyilona!
Have you already seen what we have so far, on the website? https://inkscape.org/en/develop/extensions/
Since writing extensions is mostly over my head, I can't judge which contents are complete or which need more "flesh". But others will chime in soon.
I just wanted to say welcome :-)
All best, brynn
-----Original Message----- From: matyilona@...173... Sent: Sunday, October 29, 2017 9:33 AM To: inkscape-docs@lists.sourceforge.net Subject: [Inkscape-docs] Extensions guide
Hi,
I wrote an extension a few years ago, and just updated it this weekend. When reading through the docuemntation I saw that you're looking for someone to write/flesh out the extension guide. I'd like to give it a try.
I have experience with with inkscape and python both, not so much with ruby and perl. I have not found any docs for simpletransform, simplestyle, and inkex so I read trough them. They are pretty easy to understand, but it would be nice if there were some deatails about them on the wiki, not just articles using them.
matyilona
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
Hi,
if it's ok, I'd like this email (matyilona@...173...) with the username matyilona.
Thanks, matyilona
On Sun, Oct 29, 2017 at 06:40:02PM +0100, Maren Hachmann wrote:
Hi matyilona,
some documentation for those main modules would be helpful, indeed.
If you let us know your desired user name / email address for the Wiki, we can provide you with access, so you can start right away, while the info is still fresh in your mind :)
Regards, Maren
Am 29.10.2017 um 17:33 schrieb brynn:
Welcome matyilona!
Have you already seen what we have so far, on the website? https://inkscape.org/en/develop/extensions/
Since writing extensions is mostly over my head, I can't judge which contents are complete or which need more "flesh". But others will chime in soon.
I just wanted to say welcome :-)
All best, brynn
-----Original Message----- From: matyilona@...173... Sent: Sunday, October 29, 2017 9:33 AM To: inkscape-docs@lists.sourceforge.net Subject: [Inkscape-docs] Extensions guide
Hi,
I wrote an extension a few years ago, and just updated it this weekend. When reading through the docuemntation I saw that you're looking for someone to write/flesh out the extension guide. I'd like to give it a try.
I have experience with with inkscape and python both, not so much with ruby and perl. I have not found any docs for simpletransform, simplestyle, and inkex so I read trough them. They are pretty easy to understand, but it would be nice if there were some deatails about them on the wiki, not just articles using them.
matyilona
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
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
Yes, of course that's okay :)
You should have received an email with a random password for your first login.
Regards, Maren
Am 29.10.2017 um 18:56 schrieb matyilona@...173...:
Hi,
if it's ok, I'd like this email (matyilona@...173...) with the username matyilona.
Thanks, matyilona
On Sun, Oct 29, 2017 at 06:40:02PM +0100, Maren Hachmann wrote:
Hi matyilona,
some documentation for those main modules would be helpful, indeed.
If you let us know your desired user name / email address for the Wiki, we can provide you with access, so you can start right away, while the info is still fresh in your mind :)
Regards, Maren
Am 29.10.2017 um 17:33 schrieb brynn:
Welcome matyilona!
Have you already seen what we have so far, on the website? https://inkscape.org/en/develop/extensions/
Since writing extensions is mostly over my head, I can't judge which contents are complete or which need more "flesh". But others will chime in soon.
I just wanted to say welcome :-)
All best, brynn
-----Original Message----- From: matyilona@...173... Sent: Sunday, October 29, 2017 9:33 AM To: inkscape-docs@lists.sourceforge.net Subject: [Inkscape-docs] Extensions guide
Hi,
I wrote an extension a few years ago, and just updated it this weekend. When reading through the docuemntation I saw that you're looking for someone to write/flesh out the extension guide. I'd like to give it a try.
I have experience with with inkscape and python both, not so much with ruby and perl. I have not found any docs for simpletransform, simplestyle, and inkex so I read trough them. They are pretty easy to understand, but it would be nice if there were some deatails about them on the wiki, not just articles using them.
matyilona
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
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
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
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
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
Am 07.11.2017 um 01:08 schrieb Maren Hachmann:
@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)?
None that I'm aware of...
The "Doxyfile" is now in buildtools/ (https://gitlab.com/inkscape/inkscape/blob/master/buildtools/Doxyfile) and should be working for the src/ directory.
One question is if we want to document Inkscape source and Python extension API in the same document or if those should be kept separate (effectively people can write extensions without knowing or caring about the Inkscape code and vice versa). Maybe it even simplifies the doxygen configuration if those are split (unfortunately I don't have any experienced here myself)?
Best Regards, Eduard
One question is if we want to document Inkscape source and Python extension API in the same document
Not sure what you mean by this, but I suppose it's better if they're separate. Doesn't Doxygen generate one page per class/module/interface/whatever? So they would both be automatically linked from an 'index' page...
We could reuse the same configuration or create a new one, imo depends on the relative size of additional changes needed. Perhaps just adding *.py to FILE_PATTERNS and the extension directory to INPUT would do the job and doxygen will index everything nicely? I'm going to experiment with some dummy documentation comments in extensions and see how it'll work.
Btw http://wiki.inkscape.org/wiki/index.php/Doxygen_documentation "Inkscape Doxygen Documentation is not currently available online"
any specific reason for this? Or it's just the ease of generating it locally that renders it unnecessary?
Cheers, Mois
Am 07.11.2017 um 12:15 schrieb Mois:
One question is if we want to document Inkscape source and Python extension API in the same document
Not sure what you mean by this, but I suppose it's better if they're separate. Doesn't Doxygen generate one page per class/module/interface/whatever? So they would both be automatically linked from an 'index' page...
We could reuse the same configuration or create a new one, imo depends on the relative size of additional changes needed. Perhaps just adding *.py to FILE_PATTERNS and the extension directory to INPUT would do the job and doxygen will index everything nicely? I'm going to experiment with some dummy documentation comments in extensions and see how it'll work.
Btw http://wiki.inkscape.org/wiki/index.php/Doxygen_documentation "Inkscape Doxygen Documentation is not currently available online"
any specific reason for this? Or it's just the ease of generating it locally that renders it unnecessary?
- As far as I know (cave: I'm not a developer, this is only what I gathered from mailing lists and other communication with devs), these are the reasons:
- the Jenkins instance we once used for generating it is disabled, because - there's no maintainer - we have CI via gitlab/Appveyor/(no idea for Mac) now - the website resources (RAM, CPU, disk space) are scarce - we didn't have any requests for it (as far as I know)
So if you would like to generate it via CI and make the result available for the website to either link to or to copy it (and ideally, can also help with that), I think there's no problem with that, and it can be helpful for others (esp. the documenting part) :)
Maren
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
Just create an account :-) Then learn about the gitlab workflow.
New developers are required to make merge requests for their first couple of contributions to Inkscape, and even seasoned devs, who already have access to the repository's master and other official branches, very often ask for feedback from others before they merge in their changes (or the reviewer merges).
See here for a general introduction to being an Inkscape developer: https://inkscape.org/en/develop/
Am 07.11.2017 um 14:08 schrieb Mois:
So if you would like to generate it via CI and make the result available
Cool, where do I sign? Where do I get creds for gitlab?
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
Clarification: Inkscape is on gitlab.com: https://gitlab.com/inkscape/inkscape
Am 07.11.2017 um 14:24 schrieb Maren Hachmann:
Just create an account :-) Then learn about the gitlab workflow.
New developers are required to make merge requests for their first couple of contributions to Inkscape, and even seasoned devs, who already have access to the repository's master and other official branches, very often ask for feedback from others before they merge in their changes (or the reviewer merges).
See here for a general introduction to being an Inkscape developer: https://inkscape.org/en/develop/
Am 07.11.2017 um 14:08 schrieb Mois:
So if you would like to generate it via CI and make the result available
Cool, where do I sign? Where do I get creds for gitlab?
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
Thanks for the info!
I'm glad there are code reviews :) I hope to be able to contribute.
Mois
On 11/07/2017 03:27 PM, Maren Hachmann wrote:
Clarification: Inkscape is on gitlab.com: https://gitlab.com/inkscape/inkscape
Am 07.11.2017 um 14:24 schrieb Maren Hachmann:
Just create an account :-) Then learn about the gitlab workflow.
New developers are required to make merge requests for their first couple of contributions to Inkscape, and even seasoned devs, who already have access to the repository's master and other official branches, very often ask for feedback from others before they merge in their changes (or the reviewer merges).
See here for a general introduction to being an Inkscape developer: https://inkscape.org/en/develop/
Am 07.11.2017 um 14:08 schrieb Mois:
So if you would like to generate it via CI and make the result available
Cool, where do I sign? Where do I get creds for gitlab?
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
Hey Mois,
great - I'm looking forward to your involvement and hope you'll enjoy being a contributor to Inkscape :)
Maren
Am 07.11.2017 um 14:50 schrieb Mois:
Thanks for the info!
I'm glad there are code reviews :) I hope to be able to contribute.
Mois
On 11/07/2017 03:27 PM, Maren Hachmann wrote:
Clarification: Inkscape is on gitlab.com: https://gitlab.com/inkscape/inkscape
Am 07.11.2017 um 14:24 schrieb Maren Hachmann:
Just create an account :-) Then learn about the gitlab workflow.
New developers are required to make merge requests for their first couple of contributions to Inkscape, and even seasoned devs, who already have access to the repository's master and other official branches, very often ask for feedback from others before they merge in their changes (or the reviewer merges).
See here for a general introduction to being an Inkscape developer: https://inkscape.org/en/develop/
Am 07.11.2017 um 14:08 schrieb Mois:
So if you would like to generate it via CI and make the result available
Cool, where do I sign? Where do I get creds for gitlab?
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
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
participants (5)
-
unknown＠example.com -
brynn -
Eduard Braun -
Maren Hachmann -
Mois