Development Process

Todo

Document the development process

Useful Links

• reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html

• Docstring sections: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#docstring-sections

• Python Domain Roles: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#python-roles

TODO List

See a list of documentation TODO:

Todo

Document the development process

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tkmilan/checkouts/stable/docs/development.rst, line 4.)

Todo

Include a hero image here, a screenshot of the showcase.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tkmilan/checkouts/stable/docs/index.rst, line 25.)

Todo

Include these links on the regular TOC

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tkmilan/checkouts/stable/docs/index.rst, line 44.)

Debug Environment Variables

If you run your program in __debug__ mode, the following environment variables can be used:

TKMILAN_DEBUG

Produce more debug output for a specific section. The list of sections is:

• grid: On the fn.debugWidget function, for container widgets,

  debug the grid configuration (all rows and columns).

• grid:debug: Produce an enormous amount of logs for every grid

  manipulation.

• layout:debug: Produce an enormous amount of logs for every single

  autolayout execution.

• validation:debug: Produce an enormous amount of logs for every

  single widget validation.

• canvas:render: Produce an enormous amount of logs for the canvas

  rendering process.

• secondarywindow: Debug SecondaryWindow mapping and unmappings.

Include the sections you want separated by ,.

For example:

TKMILAN_DEBUG=grid tkmilan-showcase