[OpenSIPS-Devel] Changing module documentation

[Dan Pascu]

Thanks

On 17 Apr 2019, at 9:54, Liviu Chircu wrote:

> There are three documentation-related scripts in place:
> 
> * the module documentation[1], the HTMLs regenerate every 6 hours out of the .xml files
> * the README file auto-generation (you are no longer required to maintain those) + contributor statistics updates -- these regenerate once a week, by opensips-github, on Sundays.  No explicit triggering is needed.
> * the module function index[2], regenerates every 5 minutes, as it's not that costly to do (runs almost instantly)
> 
> [1]: https://opensips.org/Documentation/Modules-3-0
> [2]: https://www.opensips.org/Documentation/Function-Index-3-0
> 
> Liviu Chircu
> OpenSIPS Developer
> http://www.opensips-solutions.com
> 
> On 17.04.2019 09:41, Dan Pascu wrote:
>> How does this work? I noticed there is a opensips-github bot that commits "Rebuild documentation" patches every now and then to update module READMEs. Is this process triggered periodically or does it just detect when xml documents changed and triggers only then? After I modify some module xml documentation and commit a patch do I need to do anything to trigger this?
>> 
>> --
>> Dan
>> 
>> 
>> 
>> 
>> 
>> _______________________________________________
>> Devel mailing list
>> Devel at lists.opensips.org
>> http://lists.opensips.org/cgi-bin/mailman/listinfo/devel
> 
> _______________________________________________
> Devel mailing list
> Devel at lists.opensips.org
> http://lists.opensips.org/cgi-bin/mailman/listinfo/devel


--
Dan