PyOpenSci REVIEW - add setup to docs, add building docs to contributing

[Robaina]

This PR addresses one of the comments from reviewer @Batalex in PyOpenSci:

Documentation

• I recommend adding "Installation" & "Getting Started" sections in the documentation. The rationale is as follows: any part of the project may be a potential user's first contact. This includes the README file, the package description on Pypi (not applicable here) / a conda channel, and the documentation.

Agreed!

• I would advise adding instructions on how to locally build the documentation in CONTRIBUTING.md in the section

Yes, that would be necessary. Will do.

3. Improving the documentation

• The following mention is incorrect in the example notebook:

To follow this example, you don't need to download _E. coli's_ genome, since it has been already downloaded during Pynteny's installation.

The MG1655.gb file is stored in the tests folder, which is not included in the package. Therefore, when the package is installed using conda, it is not downloaded.

[Batalex]

Hey @Robaina, here is how we can collaborate in PRs!
Though I am not a reviewer on this one, I can submit feedback on the committed changes.

This way, we can deal with it without opening a new PR

[Batalex]

🚀

[codecov]

Codecov Report

Base: 86.07% // Head: 86.47% // Increases project coverage by +0.39% 🎉

Coverage data is based on head (6c5a777) compared to base (b2d6595).
Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #50      +/-   ##
==========================================
+ Coverage   86.07%   86.47%   +0.39%     
==========================================
  Files          11       12       +1     
  Lines         826      806      -20     
==========================================
- Hits          711      697      -14     
+ Misses        115      109       -6     

Impacted Files	Coverage Δ
pynteny/api.py	75.67% <0.00%> (-0.65%)	⬇️
pynteny/preprocessing.py	90.24% <0.00%> (-0.19%)	⬇️
tests/test_preprocessing.py	98.00% <0.00%> (ø)
pynteny/parser.py
pynteny/parsers/syntenyparser.py	86.41% <0.00%> (ø)
pynteny/parsers/labelparser.py	91.66% <0.00%> (ø)
tests/test_parser.py	96.77% <0.00%> (+0.10%)	⬆️
pynteny/filter.py	77.45% <0.00%> (+0.22%)	⬆️
pynteny/hmm.py	80.64% <0.00%> (+4.40%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.