-
Notifications
You must be signed in to change notification settings - Fork 672
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
Update Blacklist settings docs #308
Merged
Andrew-Chen-Wang
merged 2 commits into
jazzband:master
from
saadmk11:update-blacklist-settings-docs
Sep 25, 2020
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be a :ref:, not a link? (Not good with docs). Otherwise, I think it's ok to add this. Just capitalize "Django" or remove the word entirely to be in accordance with DSF.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I think removing it would be better. So, removed it. :)
It looks like this. ref: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc
Maybe enabling Read the Docs pull request builder would be great for reviewing docs.:)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @saadmk11 Never heard of it, but if you'd like to help incorporate that to, I'd love to see it! Would make my life easier :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Andrew-Chen-Wang Sure! 👍
It's fairly simple you just need to enable it from Read the Docs dashboard.
You need to go to
Admin > Advanced settings
for this project on Read the Docs dashboard and Enable theBuild pull requests for this project
option.More details here: https://docs.readthedocs.io/en/stable/guides/autobuild-docs-for-pull-requests.html
Would love to contribute to this project, I'm new to this codebase but I'll look through some issues. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! I may be a maintainer, but I don't have access to bumping versions, PyPi, and RTD so if there is anything that we do need to enable externally from GitHub, please let me know as only David has those aforementioned capabilities!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope, you need to enable the option that I mentioned from the RTD dashboard.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, I don't have that capability. It was just a future reference in that you'll need to tell me detailed of what to enable.