search

sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.61k stars 2.13k forks source link

Use type and default option to confval in napoleon docs #13094

Open Snoopy1866 opened 3 weeks ago

Snoopy1866 commented 3 weeks ago

Subject: Use type and default option to confval in napoleon docs

Feature or Bugfix

Purpose

Use type and default option to confval in napoleon docs.

Detail

None

Relates

None

Snoopy1866 commented 2 weeks ago

I have updated the PR title to reflect changes not only to the documentation of the napoleon_attr_annotations option but also to all options within sphinx.ext.napoleon.

The previous title no longer accurately represented the scope of the updates.

However, I have not changed the branch name, as doing so would close this PR.

Snoopy1866 commented 2 weeks ago

Inspired by the below code, I add the code-py interpreted text role. https://github.com/sphinx-doc/sphinx/blob/230ccf2a44d750f5d6c5542f970f48ffe0cbce1e/doc/usage/configuration.rst?plain=1#L2917-L2919

Snoopy1866 commented 2 weeks ago

readthedocs build succeeded, while github action build failed. It looks confusing.