30 MLPro Extension

This documentation outlines a comprehensive step-by-step guide for creating a new MLPro extension to augment the functionalities of the MLPro library.

1. To begin, open GitHub and log in using the "mlpro-admin" credentials.

2. Access the MLPro extension template and create a new repository from it.

   

3. Specify the repository name (MLPro-Int-XXXX), description (MLPro: Integration XXXX), and select the visibility (public, internal, or private), then proceed to create the repository.

   

4. Once the repository is created, generate a new token to enable unit test functionality.

   

   

   

   

5. Add a unique note for the token (MLPro-Int-XXXX CI/Unit Test), set the expiration to "No expiration," and enable the "repo" scope to allow full control of private repositories. Finally, click "Generate token" to create the token.

   

   

6. Once generated, the token will appear on your screen. Please note that it will only be visible once. Make sure to copy and paste it somewhere for temporary storage.

   

   

7. You can now add the token to the unit test's actions secret key for further integration. Please proceed to add it as a new secret key named "CI_UNIT_TEST" for the repository. Upon successful addition, the new secret will appear on your screen.

   

   

   

   

8. Next, proceed to log in to the Read the Docs portal.

   

9. Import your project by selecting your repository from the list of projects. Note that it might take some time for your new repository to appear in the list, so be patient and refresh the page as needed until you locate your repository. Once found, click the "+" button to initiate the import process.

   

   

   

   

10. Build your version and wait until it is fully built. Then, try opening the documentation from the provided URLs. If the documentation opens successfully, it indicates that your documentation has been built successfully and is accessible to the public.

    

    

11. Return to your GitHub repository and navigate to the settings. Then, add the URL of the documentation to the website section and include relevant topics to categorize the repository effectively.

    

    

12. Your repository is now fully configured and ready for use.