Adding documentation and Examples to the repo [version:1.0.4]

[eduardojsbarroso]

We need to add documentation:

• To the code modules
• Readme describing the repo
• Documentation to installation
• Documentation on how to contribute
• Generate documentation with sphinx
• Add documentation generation to github actions

[eduardojsbarroso]

@caioolivv Hi, I created this PR for the documentation. I think we should organize everything like the CLMM documentation, docs.

I did some initial implementation but I was not vera detailed here.

• We should have equations describing the functions if fit
• We have to check if all masses are indeed just solar or someplace they are divided by h (For instance completeness and purity in the aguena paper are defined with M/h, so I do not know if this is a problem Aguena16)

Let me know if you are able to work on this. Thanks

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.36%. Comparing base (588407d) to head (1a440a5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #67   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files          28       29    +1     
  Lines        1771     1772    +1     
  Branches       58       58           
=======================================
+ Hits         1742     1743    +1     
  Misses         29       29           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[eduardojsbarroso]

@m-aguena could we get this approved and then maybe @caioolivv do a second PR to generate the documentation automatically and also we fix a page like lsstdesc.org/crow?

For now this would at least add some documentation for the code that people were requesting it, and also the examples

[eduardojsbarroso]

@m-aguena I added a codecov.yml file in the repo because sometimes we have a bug of -0.05% drop on coverage when we changed nothing.

I added CI generation of the documentation as well, I think this is good to go

[m-aguena]

Great job!