pysat / pysatNASA

pysat support for NASA Instruments
BSD 3-Clause "New" or "Revised" License
21 stars 6 forks source link

DOC/STY: formatting contributing page in docs #108

Closed jklenzing closed 2 years ago

jklenzing commented 2 years ago

Description

Addresses #106

Fixes the formatting of the contributing doc for RTD. Updates some info on the contributing page based on the latest pysat develop branch.

Minor formatting updates for the ICON EUV docstring and example code.

Type of change

How Has This Been Tested?

Inspection of the build page at RTD:

https://pysatnasa.readthedocs.io/en/sty-rtd/develop_guide/contributing.html

Also at the github level: https://github.com/pysat/pysatNASA/blob/sty/rtd/CONTRIBUTING.md

Checklist:

jklenzing commented 2 years ago

Style should be consistent, but I can't get rst to recognize the bullets. Documentation says that asterisks should be fine, but these aren't being built in sphinx.

EDIT: Needed to upgrade sphinx (>=4.3) to get the bullets to work for my local files.

aburrell commented 2 years ago

Also recommend adding ReadTheDocs to the CI checks. Would be especially useful for this PR.

jklenzing commented 2 years ago

Also recommend adding ReadTheDocs to the CI checks. Would be especially useful for this PR.

I see these are enabled in the pysat PRs, but don't see how to enable them in settings.

aburrell commented 2 years ago

I see these are enabled in the pysat PRs, but don't see how to enable them in settings.

I never remember how to do this, but I think it was as simple as adding a webhook in the settings.

jklenzing commented 2 years ago

I never remember how to do this, but I think it was as simple as adding a webhook in the settings.

All the projects have the same webhook, but only pysat is actually linking in the CI checks. Tried deleting and reconfiguring here.

jklenzing commented 2 years ago

All the projects have the same webhook, but only pysat is actually linking in the CI checks. Tried deleting and reconfiguring here.

Looks like it's a setting in readthedocs: "Build pull requests" under advanced settings. Reinstalling readthedocs since I broke the settings.