search

pyfar / gallery

Creative Commons Attribution 4.0 International
2 stars 1 forks source link

Add installation and contributing guidelines #51

Closed f-brinkmann closed 1 month ago

f-brinkmann commented 3 months ago
ahms5 commented 3 months ago

I have added the rst files to a new subpage, so it has the same style as https://pydata-sphinx-theme.readthedocs.io/en/stable/community/index.html. Then we can see how we ditribute all the information. see https://pyfar-gallery--51.org.readthedocs.build/en/51/community/index.html

ahms5 commented 3 months ago

52 should fix all the header linking problems

mberz commented 3 months ago

I've just skimmed the contribution guidelines. I'd prefer splitting them into a package specific and a general part. The specific part is the first half of the current guidelines, the general part is approx the second half of the current guidelines. Otherwise there are a lot of links which would need to be adapted or do not make sense depending on the package one is working on.

ahms5 commented 3 months ago

I have merged main into this branch and added a header entry for Contribute (we can rename it) and we can decide on the structure in Contribute tab together.

pingelit commented 2 months ago

I just noticed, that when we add #59, the header link "Contributing" will lead to a page whose title is "Community". I recon we should adapt that.

f-brinkmann commented 2 months ago

I just noticed, that when we add #59, the header link "Contributing" will lead to a page whose title is "Community". I recon we should adapt that.

Lets first merge #59 in this case

f-brinkmann commented 2 months ago

@pingelit : We now consistently refer to the 'Contribute' section. Using community would also be possible and both terms are used by other packages. I think contribute might be a little clearer.

@ahms : I removed the sidebar configuration in conf.py that you highligted. I did not see any changes after removing it. I think used the defaults anyhow.

The failing test is caused by the TU-Berlin page being extremely slow. Everything is fine, apart from that.

f-brinkmann commented 1 month ago

Thanks for reviewing. I removed the deprecated intersphinx links and hope that its not a beer.

Thank you for taking care! since the Help section does not have an subpages we could hide the sidebar by adding this in the docs/conf.py

I would also be ok with leaving this as it is. In that case its less error prone if we add sections at a later point

ahms5 commented 1 month ago

Thanks for reviewing. I removed the deprecated intersphinx links and hope that its not a beer.

If so, I would take it over.