Skip to content
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

Improve autodoc docs #12935

Merged
merged 5 commits into from
Oct 2, 2024
Merged

Improve autodoc docs #12935

merged 5 commits into from
Oct 2, 2024

Conversation

timhoffm
Copy link
Contributor

@timhoffm timhoffm commented Oct 1, 2024

  • Clarify docs on how to reference directive options
  • autodoc improvements:
    • Cross-link the 'autodoc_default_options' to the descriptions of the respective directive options
    • Add types and defaults to config parameters
      Please check how you would like the type and default to be soecified. - It's not consistent throughout
      the codebase, so I took some convention
    • deleted the docs for the config value autodoc_default_flags, which already has been removed a long time ago.
    • minor formatting improvements

@timhoffm timhoffm changed the title DOC: Improve autodoc docstrings DOC: Improve autodoc docs Oct 1, 2024
@timhoffm timhoffm force-pushed the doc-autodoc2 branch 3 times, most recently from cf9a443 to deceef0 Compare October 1, 2024 16:58
- Cross-link the 'autodoc_default_options' to the
  descriptions of the respective directive options
- Add types and defaults to config parameters
- minor formatting improvements
@AA-Turner
Copy link
Member

  • Please check how you would like the type and default to be soecified. - It's not consistent throughout the codebase, so I took some convention

I spent several weeks over the summer rewriting usage/configuration.rst, so that style is preferred: https://www.sphinx-doc.org/en/master/usage/configuration.html

A

@AA-Turner AA-Turner changed the title DOC: Improve autodoc docs Improve autodoc docs Oct 2, 2024
@AA-Turner AA-Turner enabled auto-merge (squash) October 2, 2024 23:02
@AA-Turner AA-Turner enabled auto-merge (squash) October 2, 2024 23:02
@AA-Turner AA-Turner merged commit b16e196 into sphinx-doc:master Oct 2, 2024
7 of 8 checks passed
@timhoffm timhoffm deleted the doc-autodoc2 branch October 3, 2024 05:48
@AA-Turner AA-Turner added this to the 8.1.x milestone Oct 6, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants