-
-
Notifications
You must be signed in to change notification settings - Fork 163
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: fix broken internal refs, fix broken intersphinx cross-refs to multidict, minor styling fixes #665
Conversation
…fs to multidict, minor styling fixes Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Codecov Report
@@ Coverage Diff @@
## master #665 +/- ##
=======================================
Coverage 99.72% 99.72%
=======================================
Files 4 4
Lines 717 717
Branches 162 162
=======================================
Hits 715 715
Misses 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
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.
Looks like this patch could be coupled with adding strictness to the Sphinx setup. I like having default_role = 'any'
and nitpicky = True
in conf.py
for this.
Also, adding -W --keep-going -n
to the sphinx-build
invocation is as helpful.
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
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.
LGTM, thanks!
…multidict, minor styling fixes (aio-libs#665)
What do these changes do?
This PR contains only documentation improvements, no code changes.
URL.human_repr()
are fixed.intersphinx
config, fixed broken URL tomultidict
docs.Are there changes in behavior for the user?
No
Related issue number
Didn't create one since the changes are trivial IMO
Checklist
Unit tests for the changes existnot needed, but an extra job in theci
action could watch over the docs and fail if new errors are introducedCHANGES
folder<issue_id>.<type>
(e.g.588.bugfix
)issue_id
change it to the pr id after creating the PR.feature
: Signifying a new feature..bugfix
: Signifying a bug fix..doc
: Signifying a documentation improvement..removal
: Signifying a deprecation or removal of public API..misc
: A ticket has been closed, but it is not of interest to users.Fix issue with non-ascii contents in doctest text files.