-
Notifications
You must be signed in to change notification settings - Fork 51
Fix some small things #182
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
base: master
Are you sure you want to change the base?
Conversation
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.
I made some grammar corrections, but also some suggestions for improving presentation. We could add sphinx-examples
, but not in this PR, to get a further improved presentation.
Co-authored-by: Steve Piercy <web@stevepiercy.com>
c7cee27
to
8e16946
Compare
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. Thank you!
Co-authored-by: Steve Piercy <web@stevepiercy.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.
OK, now I really approve. 😉
# TODO: | ||
# - show roles to refer to elements | ||
# - async with | ||
# - async for | ||
# - add example of numpy-style docstrings | ||
# - show the roles to refer to the listed directives | ||
# - missing: async with, async for | ||
# - add example(s) of numpy-style docstrings |
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.
@cmarqu would you please create issues for each of these todos to give them greater visibility, then remove them here?
These will become proper GitHub 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.
@cmarqu I just realized that you need to edit https://github.com/sphinx-themes/sphinx-themes.org/blob/master/src/templates/conf.template.py#L32-L34 as shown below, else :py:keyword:`async`
won't render at build time.
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"sphinx": ("https://www.sphinx-doc.org/en/master/", None),
}
Oh, right... so many things that play together. |
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.
Third time's the charm!
I want to go over the file once more still.
@stevepiercy I'd appreciate if you could also take another look as you did for the domain-specific files (thanks for that).