Skip to main content

Documentation generation II

So I've been working no getting the documentation generator up and running.

So far the plan is to use sphinx to do the document generation on .rst files that we'll generate using the document parser.

Developers won't have to worry about any of this, since the .py files for each widget, signal class, and qtWidget will be parsed for documentation using our own document parsing functions.

We'll be running the create doc function each time a new package is installed. This does result in a lot of duplicate documentation generation of the core documentation and of packages each time a new package is installed or deleted. The advantage is that this way there is one location in which to execute the search query to interact with the core search functionality on the local drive. In the end it's a sacrifice of cycle time for better searching and since cycle time is relatively cheap and can run in background, we're not too worried about it.

Developers are encouraged to expand their packages with documentation in the extras directory of their help directories. This will include any .rst files into the search and can be used to further expand packages.

Feel free to post any questions or comments to the forum.
Kyle