diff --git a/docs/source/contributions.rst b/docs/source/contributions.rst index 9f9b3b6a..8a50041b 100644 --- a/docs/source/contributions.rst +++ b/docs/source/contributions.rst @@ -13,7 +13,7 @@ Contributions can be slow, but the closer the pull request is to our guidelines The required new files for any new module are listed below and an example file structure of the additional files is shown in the figure below. .. image:: ./images/module_addition_file_structure.png - :width: 300px + :width: 330px :align: right * Python file: Create a new Python file named **.py** under the folder **hypernetx/hypernetx/algorithms/.**. This file will contain the core functionalities of your module. All methods need to have docstrings in the new module. @@ -22,6 +22,8 @@ The required new files for any new module are listed below and an example file s * Test file: Write unit tests for your module in a file named **test_.py** under the tests folder located at **hypernetx/tests/algorithms/.**. These tests should ensure the correctness and functionality of your code. +* Documentation: Write an rst file named **.rst** under the algorithms documentation folder located at **hypernetx/docs/source/algorithms/.**. This documentations should focus on the mathematics or theory behind your module with citations to relevant papers and documents. Additionally it should provide code snippets demonstrating usage that parallel the tutorial. + Step-by-Step Process ~~~~~~~~~~~~~~~~~~~~ @@ -35,6 +37,8 @@ Step-by-Step Process #. Testing: Write unit tests in the test_.py file to ensure your module functions as expected. This should be located in the algorithm tests folder. In the top hypernetx directory you can use the makefile and the command ``make test`` to validate everything is passing. Please see other tests and follow a similar format. +# Read the Docs: Include your rst file in the algorithms folder of the source docs overviewing the theory/mathematics of the new module with example code. See other rst files as examples of formatting. + #. __init__.py Update: Update the __init__.py file in the **hypernetx/hypernetx/algorithms/** folder to import your new module. Please follow the style of importing used by the other modules. #. Commit and Push: Commit your changes with clear and concise commit messages describing each modification. Push your commits to your branch on the remote repository. diff --git a/docs/source/images/module_addition_file_structure.png b/docs/source/images/module_addition_file_structure.png old mode 100755 new mode 100644 index b85580be..6308decb Binary files a/docs/source/images/module_addition_file_structure.png and b/docs/source/images/module_addition_file_structure.png differ