Add 'contributing' and 'code reference' docs to repo #29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nabobalis
reviewed
Aug 4, 2020
| ============ | ||
|
|
||
| Code of Conduct | ||
| --------------- |
There was a problem hiding this comment.
I would probably just link to the sunpy one.
There was a problem hiding this comment.
I ended up doing something a little different as it felt a bit odd to use the same licence for the Code of Conduct for glue-solar with sunpy, so I adapted the sunpy one. Hope this arrangement is okay with you.
nabobalis
reviewed
Aug 4, 2020
nabobalis
reviewed
Aug 4, 2020
nabobalis
force-pushed
the
add-other-docs
branch
from
0256683
to
fca4737
Compare
nabobalis
reviewed
Aug 4, 2020
nabobalis
force-pushed
the
add-other-docs
branch
from
7ffe2dd
to
195a900
Compare
added 3 commits
August 5, 2020 00:57
nabobalis
reviewed
Aug 4, 2020
nabobalis
reviewed
Aug 4, 2020
nabobalis
reviewed
Aug 4, 2020
nabobalis
force-pushed
the
add-other-docs
branch
from
e4291c8
to
e74bcd6
Compare
kakirastern
changed the title
nabobalis
reviewed
Aug 10, 2020
Comment on lines
+69
to
+93
| # -- Turn on nitpicky mode for sphinx (to warn about references not found) ---- | ||
| # | ||
| # nitpicky = True | ||
| # nitpick_ignore = [] | ||
| # | ||
| # Some warnings are impossible to suppress, and you can list specific references | ||
| # that should be ignored in a nitpick-exceptions file which should be inside | ||
| # the docs/ directory. The format of the file should be: | ||
| # | ||
| # <type> <class> | ||
| # | ||
| # for example: | ||
| # | ||
| # py:class astropy.io.votable.tree.Element | ||
| # py:class astropy.io.votable.tree.SimpleElement | ||
| # py:class astropy.io.votable.tree.SimpleElementWithContent | ||
| # | ||
| # Uncomment the following lines to enable the exceptions: | ||
| # | ||
| # for line in open('nitpick-exceptions'): | ||
| # if line.strip() == "" or line.startswith("#"): | ||
| # continue | ||
| # dtype, target = line.split(None, 1) | ||
| # target = target.strip() | ||
| # nitpick_ignore.append((dtype, six.u(target))) |
There was a problem hiding this comment.
It is for in case we will need to use it in the future to turn on nitpicky. I have used it for some astropy docs before, and thought we might need it someday if our docs grow larger in size and there might be some problems that can only be resolved by nitpick-exceptions.
nabobalis
reviewed
Aug 10, 2020
nabobalis
reviewed
Aug 10, 2020
nabobalis
reviewed
Aug 10, 2020
nabobalis
reviewed
Aug 10, 2020
nabobalis
reviewed
Aug 10, 2020
nabobalis
requested changes
Aug 10, 2020
Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
|
Thanks @nabobalis! Suggested changes committed and waiting for tests to pass. |
Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
nabobalis
approved these changes
Aug 10, 2020
|
Appreciate it @nabobalis |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add the remaining main documentation to
docs, includingcontributingandcode reference, to supplement theuser's guideanddeveloper's guidealready added to repo.