Docs/add api reference

.github/ISSUE_TEMPLATE/documentation_improvement.md

@@ -0,0 +1,15 @@
+---
+name: Documentation improvement
+about: Create a report to help us improve
+title: '[DOC] '
+labels: 'documentation'
+assignees: ''
+
+---
+
+## What part of the documentation do you want to update?
+<!-- A clear and concise description of what part of the documentation you want to update. -->
+
+## What changes do you want to make?
+<!-- A clear and concise description of what changes you want to make. -->
+

.pre-commit-config.yaml

@@ -11,13 +11,13 @@ repos:
         additional_dependencies: [types-pyyaml]
         exclude: tests/
 
-  - repo: local
-    hooks:
-      - id: check-pruna-pro
-        name: Check for pruna_pro
-        entry: >
-          bash -c "git diff --cached --name-status | grep -v \"^D\" | grep -E \"^[A-Z]\\s+docs/\" | cut -f2- | while IFS= read -r file; do if [ -f \"$file\" ] && grep -q \"pruna_pro\" \"$file\"; then echo \"Error: pruna_pro found in staged file $file\"; exit 1; fi; done || [ $? -eq 1 ] && exit 1 || exit 0"
-        language: system
-        stages: [pre-commit]
-        types: [text]
-        files: '^docs/'
+  # - repo: local
+  #   hooks:
+  #     - id: check-pruna-pro
+  #       name: Check for pruna_pro
+  #       entry: >
+  #         bash -c "git diff --cached --name-status | grep -v \"^D\" | grep -E \"^[A-Z]\\s+docs/\" | cut -f2- | while IFS= read -r file; do if [ -f \"$file\" ] && ! grep -q \"pruna_pro\" \"$file\"; then echo \"Error: pruna_pro not found in staged file $file\"; exit 1; fi; done || [ $? -eq 1 ] && exit 1 || exit 0"
+  #       language: system
+  #       stages: [pre-commit]
+  #       types: [text]
+  #       files: '^docs/'

docs/contributions/how_to_contribute.rst

@@ -1,18 +1,19 @@
 How to Contribute 💜
 ===============================
 
-Since you landed on this part of the documentation, we want to first of all say thank you! 💜 
+Since you landed on this part of the documentation, we want to first of all say thank you! 💜
 Contributions from the community are essential to improving |pruna|, we appreciate your effort in making the repository better for everyone!
 
-Please make sure to review and adhere to the `Pruna Code of Conduct <https://github.com/PrunaAI/pruna/blob/main/CODE_OF_CONDUCT.md>`_ before contributing to Pruna. 
-Any violations will be handled accordingly and result in a ban from the Pruna community and associated platforms. 
+Please make sure to review and adhere to the `Pruna Code of Conduct <https://github.com/PrunaAI/pruna/blob/main/CODE_OF_CONDUCT.md>`_ before contributing to Pruna.
+Any violations will be handled accordingly and result in a ban from the Pruna community and associated platforms.
 Contributions that do not adhere to the code of conduct will be ignored.
 
 There are various ways you can contribute:
 
 - Have a question? Discuss with us on `Discord <https://discord.gg/Tun8YgzxZ9>`_ or check out the :doc:`/resources/faq`
 - Have an idea for a new tutorial? Open an issue with a :ref:`feature-request` or chat with us on `Discord <https://discord.gg/Tun8YgzxZ9>`_
 - Found a bug? Open an issue with a :ref:`bug-report`
+- Documentation improvements? Open an issue with a :ref:`documentation-improvement`
 - Want a new feature? Open an issue with a :ref:`feature-request`
 - Have a new algorithm to add? Check out: :doc:`adding_algorithm`
 - Have a new metric to add? Check out: :doc:`adding_metric`
@@ -75,7 +76,7 @@ You can then also install the pre-commit hooks with
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 You are now ready to work on your contribution. Check out a branch on your forked repository and start coding!
-When committing your changes, we recommend to follow the `Conventional Commit Guidelines <https://www.conventionalcommits.org/en/v1.0.0/>`_. 
+When committing your changes, we recommend to follow the `Conventional Commit Guidelines <https://www.conventionalcommits.org/en/v1.0.0/>`_.
 
 .. code-block:: bash
 
@@ -84,13 +85,13 @@ When committing your changes, we recommend to follow the `Conventional Commit Gu
     git commit -m "feat: new amazing feature setup"
     git push origin feat/new-feature
 
-Make sure to develop your contribution in a way that is well documented, concise and easy to maintain. 
+Make sure to develop your contribution in a way that is well documented, concise and easy to maintain.
 We will do our best to have your contribution integrated and maintained into |pruna| but reserve the right to reject contributions that we do not feel are in the best interest of the project.
 
 4. Run the tests
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-We have a comprehensive test suite that is designed to catch potential issues before they are merged into |pruna|. 
+We have a comprehensive test suite that is designed to catch potential issues before they are merged into |pruna|.
 When you make a contribution, it is highly recommended to not only run the existing tests but also to add new tests that cover your contribution.
 
 You can run the tests by running the following command:
@@ -109,9 +110,9 @@ If you want to run only the tests with a specific marker, e.g. fast CPU tests, y
 5. Create a Pull Request
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Once you have made your changes and tested them, you can create a Pull Request. 
+Once you have made your changes and tested them, you can create a Pull Request.
 We will then review your Pull Request and get back to you as soon as possible.
-If there are any questions along the way, please do not hesitate to reach out on `Discord <https://discord.gg/Tun8YgzxZ9>`_. 
+If there are any questions along the way, please do not hesitate to reach out on `Discord <https://discord.gg/Tun8YgzxZ9>`_.
 
 
 

docs/contributions/opening_an_issue.rst

@@ -1,6 +1,27 @@
 Opening an Issue
 ===============================
 
+
+.. _documentation-improvement:
+
+Documentation Improvement
+------------------------
+
+All bits help! We appreciate your interest in improving |pruna|’s documentation.
+
+Our documentation is built with `Sphinx <https://www.sphinx-doc.org/en/master/>`_ and `Read the Docs <https://readthedocs.org/>`_.
+
+The current set-up relies on restructured text (rst) files for the documentation and forces us to evaluate and build the documentation on our side.
+This means you cannot directly evaluate the documentation changes on your local machine, however, you can still make changes to the documentation and create a pull request based on the changes.
+
+When opening a pull request for a documentation improvement, you will encounter the following template to help you structure your suggestion. Make sure to fill out all sections applicable to your feature request so that we can integrate it in Pruna as fast as possible:
+
+.. literalinclude:: issue_templates/documentation_improvement.md
+   :language: markdown
+   :linenos:
+   :lines: 9-
+
+
 .. _bug-report:
 
 Bug Report
@@ -33,7 +54,7 @@ When opening a bug report on GitHub, you will encounter the following template t
 
 Feature Request
 ---------------
-We appreciate your interest in improving |pruna|! Feature requests help shape the project, and we welcome ideas that align with our mission. 
+We appreciate your interest in improving |pruna|! Feature requests help shape the project, and we welcome ideas that align with our mission.
 
 Before submitting your feature request, consider the following points to ensure your request is clear and actionable:
 
@@ -48,4 +69,4 @@ When opening a feature request on GitHub, you will encounter the following templ
 .. literalinclude:: issue_templates/feature_request.md
    :language: markdown
    :linenos:
-   :lines: 9-
+   :lines: 9-