Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC/STY: formatting contributing page in docs #108

Merged
merged 20 commits into from
May 4, 2022
Merged

DOC/STY: formatting contributing page in docs #108

merged 20 commits into from
May 4, 2022

Conversation

jklenzing
Copy link
Member

@jklenzing jklenzing commented Apr 19, 2022

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

  • Bug fix (non-breaking change which fixes an issue)

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:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes
  • Update zenodo.json file for new code contributors

@jklenzing jklenzing added this to the 0.1.0 Release milestone Apr 19, 2022
@jklenzing jklenzing added documentation Improvements or additions to documentation style labels Apr 19, 2022
@jklenzing jklenzing linked an issue Apr 19, 2022 that may be closed by this pull request
@jklenzing jklenzing marked this pull request as draft April 19, 2022 19:17
@jklenzing
Copy link
Member Author

jklenzing commented Apr 21, 2022

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.

@jklenzing jklenzing marked this pull request as ready for review April 21, 2022 16:56
docs/examples/ex_init.rst Show resolved Hide resolved
pysatNASA/instruments/icon_euv.py Outdated Show resolved Hide resolved
@aburrell
Copy link
Member

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

@jklenzing
Copy link
Member Author

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
Copy link
Member

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
Copy link
Member Author

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
Copy link
Member Author

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.

@jklenzing jklenzing requested a review from aburrell April 25, 2022 17:33
pysatNASA/instruments/ses14_gold.py Outdated Show resolved Hide resolved
pysatNASA/instruments/timed_saber.py Outdated Show resolved Hide resolved
@jklenzing jklenzing requested a review from aburrell April 25, 2022 18:15
@jklenzing jklenzing merged commit 036e377 into develop May 4, 2022
@jklenzing jklenzing deleted the sty/rtd branch May 4, 2022 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation style
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Minor Formatting Issues, Community Contributions
2 participants