PiDoc: source codes for documentation should be in GitHub repository...

[georg.viehoever]

Best I can tell this is not the case. As a consequence, I cannot easily update documentation.
Georg

[bitli]

In addition it is not possible to publish scripts that use Pidoc in the current structure.
--  bitli

[Juan Conejero]

Unfortunately, most PIDoc source codes for documented modules are now quite obsolete after recent updates to the PIDoc language and compiler script. I plan on updating them to create a dedicated GitHub repository, but I have too many priorities right now.

You can use the XISF specification document as a good example of up-to-date PIDoc source code:

https://github.com/PixInsight/XISF-specification

Another good example is the PIDoc documentation:

http://pixinsight.com/doc/src/ref/docs/PIDocReference/PIDocReference.pidoc

I have just uploaded the source code of the documentation for ImageIntegration:

http://pixinsight.com/doc/src/ref/tools/ImageIntegration.zip

This documentation should be improved to use some important resources available in the latest version of PIDoc, especially the fact that subsections can now be nested without limits (which would allow for a much better structuration), but you can use it as a reasonably complete example of tool documentation. (Besides that, ImageIntegration has now important features that are not documented, but that's another problem...).

[georg.viehoever]

Juan,

thanks for providing the zip. I will use it as a starting point.

in dont think that creating a separate repository for documentation is such a good idea. I would very much prefer if documentation that belongs to modules or scripts would become part of the corresponding directories in the PCL or PJSR repository. Not only does this help in finding the documents, it also makes it much easier to keep them in sync with development activities.

Georg

[Carlos Milovic]

I agree with Georg.