-
Notifications
You must be signed in to change notification settings - Fork 3
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
DOCS issue #13: added libs and content for readthedocs integration #23
Merged
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
…red by the library users
…ocs dependence in a docs group
u-ways
force-pushed
the
readthedocs-feedback
branch
8 times, most recently
from
November 24, 2024 23:54
d46a573
to
47aa753
Compare
…reference our README, CONTRIBUTING and LICENSE page
u-ways
force-pushed
the
readthedocs-feedback
branch
from
November 24, 2024 23:56
47aa753
to
94b38ce
Compare
u-ways
force-pushed
the
readthedocs-feedback
branch
from
November 25, 2024 17:44
e45c9aa
to
cdac2b7
Compare
u-ways
force-pushed
the
readthedocs-feedback
branch
from
November 25, 2024 17:51
6374736
to
16cd3e7
Compare
u-ways
changed the title
DO NOT MERGE - Readthedocs PR Feedback & Testing
DOCS issue #13: added libs and content for readthedocs integration
Nov 25, 2024
4 tasks
2 tasks
Merged this, thanks again @spyingcyclops ! |
Ok, thank you, this is my first merged OSS contribution 🍾 cheers! |
@spyingcyclops - Amazing, I am sure many more to come!
|
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.
Context
This is a task worked on by @spyingcyclops
You can see the original PR here: #22
Original PR had prematurely merged a set of changes, so moving it here instead of asking them to resolve the conflicts for ease of contribution.
Summary
My first commit, please be kind & constructive :)
Done
I don't know why the README shows changes - my local env says no change to that file
To build and preview the doc locally, run:
RE DoD, unit tests and linting are passing.
I would need help running the CI/CD tests locally.
I have not added tests to check the doc build, links, or other - I would need some guidance there
To Do:
Please follow the instructions in these sections to create an RTD account, and import the GitHub project.
creating-a-read-the-docs-account and importing-the-project-to-read-the-docs
I recommend using these project settings in RTD:
Optionally, you can also add me as a maintainer of the project and I can configure/test it.
Definition of Done Checklist: