Skip to content

Conversation

cmarqu
Copy link
Contributor

@cmarqu cmarqu commented Aug 1, 2025

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).

Copy link
Contributor

@stevepiercy stevepiercy left a 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>
@cmarqu cmarqu force-pushed the docs/small-fixes branch from c7cee27 to 8e16946 Compare August 3, 2025 11:11
@cmarqu cmarqu marked this pull request as ready for review August 3, 2025 11:15
Copy link
Contributor

@stevepiercy stevepiercy left a 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>
Copy link
Contributor

@stevepiercy stevepiercy left a 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. 😉

Comment on lines 7 to 10
# 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
Copy link
Contributor

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
Copy link
Contributor

@stevepiercy stevepiercy left a 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),
}

@cmarqu
Copy link
Contributor Author

cmarqu commented Aug 4, 2025

@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.

Oh, right... so many things that play together.

Copy link
Contributor

@stevepiercy stevepiercy left a 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants