repo groups API methods not documented

[Mads Kiilerich]

I found that the supported Sphinx version had broken jinja2 dependencies 
on pypi - fixed by 
https://kallithea-scm.org/repos/kallithea/changeset/33f1faa7fe044e6cea68bf4bf65f63e2a2dc15e9 
.

With that, it works for me on linux in a venv per 
https://kallithea.readthedocs.io/en/default/contributing.html#getting-started 
. I change to docs/ and run "make html". On Windows it might be easier 
to run "sphinx-build -b html -d _build/doctrees . _build/html" directly.

Exactly what error do you get, when doing what?

/Mads


On 9/17/22 18:52, Louis Bertrand wrote:
> Hi,
> I found the api.py and started tinkering with the doc file api.rst, but I can't build the HTML with Sphinx. When it imports kallithea as a module, I get an error "unsupported version". I'm using Python 3.10 on Windows. Should I create a venv with an earlier version of Python?
> Thanks
>   --Louis
>
>
> -----Original Message-----
> From: Mads Kiilerich <mads at kiilerich.com>
> Sent: September 17, 2022 8:55 AM
> To: Louis Bertrand <Louis.Bertrand at durhamcollege.ca>; Kallithea <kallithea-general at sfconservancy.org>
> Subject: Re: repo groups API methods not documented
>
> [EXTERNAL EMAIL - USE CAUTION]
>
> Hi
>
> That is just the documentation that is incomplete (and perhaps slightly wrong).
>
> You can get an idea of the functionality by looking at the implementation in https://kallithea-scm.org/repos/kallithea/files/stable/kallithea/controllers/api/api.py
> .
>
> /Mads
>
>
> On 9/17/22 10:11, Louis Bertrand wrote:
>> Hello,
>> I am trying to use the API to manage a number of repo groups but I don't see documentation on kallithea.readthedocs.io for methods like get_repo_groups, create_repo_group, and so on. They seem to work. Are they undocumented because not stable? Or is it just a to-do?
>> My use case is managing a repo group for each student in a class such that they can all use a repo name like 'assignment1' without conflicts, and I can use the API to bulk clone repos to local for assessment. I need to bulk create those repo groups, and eventually delete them when the students graduate.
>> Thanks
>>    --Louis
>>
>> --
>> Louis Bertrand, P.Eng.
>> Professor, Faculty of Science, Engineering and Information Technology
>> Durham College
>>
>> ________________________________
>>
>> ________________________________
>> This message is intended only for the named recipients. This message may contain information that is confidential or exempt from disclosure under applicable law. Any dissemination or copying of this message by anyone other than a named recipient is strictly prohibited. If you are not a named recipient or an employee or agent responsible for delivering this message to a named recipient, please notify us immediately, and permanently destroy this message and any copies you may have. Warning: Email may not be secure unless properly encrypted.
>> _______________________________________________
>> kallithea-general mailing list
>> kallithea-general at sfconservancy.org
>> https://lists.sfconservancy.org/mailman/listinfo/kallithea-general
>