WoeUSB-ng icon indicating copy to clipboard operation
WoeUSB-ng copied to clipboard

Update documentation files

Open LightYagami28 opened this issue 1 year ago • 0 comments

Changes:

Updated the Sphinx configuration file (conf.py) to include paths to the source files and specify the project version and release information.
Updated the index.rst file to ensure that the table of contents (toctree) includes the relevant documentation files (woeusb.rst and gui.rst).
Modified the gui.rst file to use the automodule directive to include all members of the gui module, excluding undocumented members.
Updated the utils.rst file to use the automodule directive to include all members of the utils module, excluding undocumented members.
Updated the woeusb.rst file to include a toctree directive listing the imported modules (utils.rst and workaround.rst) and used the automodule directive to include all members of the woeusb module, excluding undocumented members.
Updated the workaround.rst file to use the automodule directive to include all members of the workaround module, excluding undocumented members.

Motivation:

The changes ensure that the Sphinx documentation is properly configured and includes the necessary paths and project information.
The updates to the index and module files improve the structure and organization of the documentation, making it easier for users to navigate and find relevant information.
Using the automodule directive ensures that all members of the respective modules are documented and included in the documentation, enhancing its completeness and usefulness for users.

I made other important modification pls check and made me a comment or a fix

LightYagami28 avatar May 12 '24 18:05 LightYagami28