Re: [Inkscape-docs] Adding extensions api docs

[Mois]

Thank you Eduard for notifying the devel list, and taking a look at the
new documentation!
Note that I have not yet written any additional documentation, just
wanted to have the ability to generate from it first.

I was unable to run the gitlab ci locally, so I pushed to a separate
branch and the gitlab server's ci ran on it.
https://gitlab.com/monomon/inkscape/-/jobs/40347524

As you can see, the doxygen build failed, because doxygen is not
installed on the ci machines. This probably means we have to change the
Dockerfile to include that (*if* we are to include it).

It sucks a little that gitlab are *deprecating* the exec command, which
allows you to build locally. This is a really good way to verify you
didn't miss anything obvious before pushing out.

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

Re: [Inkscape-docs] Extensions guide

[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?

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

Re: [Inkscape-docs] Extensions guide

[Mois]

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

Re: [Inkscape-docs] CSS class extension

[Mois]

Thank you, it worked.

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

Re: [Inkscape-docs] CSS class extension

[Mois]

Sorry, a few assumptions on my side :)

For username, "monomon" would be good, if available.

On 08/10/2017 04:30 PM, Maren Hachmann wrote:
> Oh, you haven't mentioned that you'd like your extension to be added to
> the Wiki list!
>
> I thought you wanted to say 'hi', tell people about your extension, and
> find out how to get involved in development.
>
> Anyway, if you want to add it to the list yourself, please do so :)
>
> Which user name would you like to have set for the Wiki?
>
> Maren
>
> Am 10.08.2017 um 15:19 schrieb Mois:
>> Oh I'm sorry, just followed the instruction on the wiki
>> <http://wiki.inkscape.org/wiki/index.php/Inkscape_Extensions>, which
>> says "please let us know (via Docs mailing list..." I am going to look
>> into fixing those instructions, then. How does one become a wiki editor?
>> Don't see a "register" button.
>>
>> Thank you I will post to those other mailing lists.
>>
>>
>> --
>> 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

Re: [Inkscape-docs] CSS class extension

[Mois]

Oh I'm sorry, just followed the instruction on the wiki
, which
says "please let us know (via Docs mailing list..." I am going to look
into fixing those instructions, then. How does one become a wiki editor?
Don't see a "register" button.

Thank you I will post to those other mailing lists.
--
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