Documentation!!

[Islast]

• [x] I'm ready to merge

• What's the context for this pull request? (this is a good place to reference any issues that this PR addresses)

  76 and #45

• What's new?

  • docstrings for all functions and classes (except make_figures, which we haven't refactored yet)
  • doc folder has been renamed docs to allow compatibility with project pages.
  • documentation should be ready to deploy to site.
  • a guide for developers at the end of the contributing guidelines

• What should a reviewer feedback on? the style of documentation or missing documentation It would be wonderful if Kirstie could look over the developer guidelines and check it all makes sense. It's actually a bit of a first draft.

• Does anything need to be updated after merge? _(e.g the wiki or the WhitakerLab website) When this is merged into master (and sadly not before) we will be able to edit the GitHub pages settings of this repository and deploy the docs folder to github pages

[rmarkello]

Hey! I'm just popping in to say that I already really like your development guide in your CONTRIBUTING.md file (even though you say they're only a first draft!) :heart_eyes: :sparkling_heart: I'm absolutely planning on adapting it for some of my own projects, so please let me know if there's anything more than a link back to this repo that you'd like me to add when I use them, e.g.:

– Based on contributing guidelines from the BrainNetworksInPython project.

Super excited to see all your work in the dev branch merged to master soon! :raised_hands:

[Islast]

Thank you so much @rmarkello I'm glad you like it! :sun_with_face: Yes, you are welcome to adapt it for your own projects, and a link like that back to BrainNetworksInPython will be more than enough :+1:

[KirstieJane]

I'm doing it! We can develop further in the WhitakerLab dev branch!! 😱 ✨ 🙌