TechQA.

Question

Custom PyCharm docstring stubs (i.e. for google docstring or numpydoc formats)

score 22391 · Answer 1 · 2013-09-06T21:31:37.867000

0

Answer

22391

Views

Custom PyCharm docstring stubs (i.e. for google docstring or numpydoc formats)

22.3k views Asked by kalefranz At 06 September 2013 at 21:31

score 6767 · Answer 2 · 2020-12-08T12:32:53.667000

sphinx warning: autosummary: stub file not found for the methods of the class. check your autosummary_generate settings

6.7k views Asked by Sole Galli At 08 December 2020 at 12:32

score 386 · Answer 3 · 2022-04-25T23:12:19.577000

Napoleon overescapes trailing underscore in parameter name leading to Unknown target name error

386 views Asked by hansemann At 25 April 2022 at 23:12

score 1145 · Answer 4 · 2020-07-26T17:37:36.137000

Is there a standard format for documenting function-type parameters in Sphinx using sphinx.ext.napoleon?

1.1k views Asked by Ben Soyka At 26 July 2020 at 17:37

score 1090 · Answer 5 · 2022-03-06T22:13:32.223000

Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention

1k views Asked by buhtz At 06 March 2022 at 22:13

score 875 · Answer 6 · 2021-02-13T06:56:05.647000

Using array-like as a type in napoleon without warning

875 views Asked by Mad Physicist At 13 February 2021 at 06:56

score 527 · Answer 7 · 2022-05-12T19:07:28.807000

Sphinx: how to show attributes as in scipy

527 views Asked by Breno At 12 May 2022 at 19:07

score 4736 · Answer 8 · 2018-05-26T19:03:22.363000

Documenting class attributes with type annotations

4.7k views Asked by Djent At 26 May 2018 at 19:03

score 1954 · Answer 9 · 2017-09-19T15:28:55.163000

how to correctly add nested list in numpy docstring in combination with sphinx docstring

1.9k views Asked by math At 19 September 2017 at 15:28

score 493 · Answer 10 · 2021-08-17T08:38:47.467000

Docstrings are not generated on Read the Docs with Sphinx autodoc and napoleon extensions

493 views Asked by Nielsen At 17 August 2021 at 08:38

score 234 · Answer 11 · 2021-09-08T22:59:24.313000

Autoappend Returns None to Sphinx Documentation

234 views Asked by lexalenka At 08 September 2021 at 22:59

score 531 · Answer 12 · 2016-05-13T15:00:00.417000

Sphinx 1.4+ and block literals in Returns with sphinx-napoleon don't work anymore

531 views Asked by Drachenfels At 13 May 2016 at 15:00

score 1247 · Answer 13 · 2017-01-20T11:25:37.987000

List of class methods with Napoleon Sphinx extension using NumPyDoc style

1.2k views Asked by Pietro Marchesi At 20 January 2017 at 11:25

score 460 · Answer 14 · 2017-01-25T13:43:15.817000

Sphinx fails when generating documentation for Django project

460 views Asked by Oskar Persson At 25 January 2017 at 13:43

score 244 · Answer 15 · 2021-06-16T02:43:15.927000

Intersphinx Docstring Readability

244 views Asked by Hyperplane At 16 June 2021 at 02:43

score 374 · Answer 16 · 2019-08-29T08:50:20.243000

Sphinx and Numpydoc throws parse error when inheriting from third party package

374 views Asked by Micromegas At 29 August 2019 at 08:50

score 289 · Answer 17 · 2019-04-01T18:50:08.127000

Text outside parameters section in sphinx

289 views Asked by Mad Physicist At 01 April 2019 at 18:50

score 35768 · Answer 18 · 2012-08-30T22:15:00.403000

Sphinx autosummary "toctree contains reference to nonexisting document" warnings

35.7k views Asked by user1287170 At 30 August 2012 at 22:15

score 9191 · Answer 19 · 2017-07-06T17:22:03.370000

Simple way to convert Python docstrings from reStructured Text to Google style?

9.1k views Asked by gmolau At 06 July 2017 at 17:22

score 299 · Answer 20 · 2016-06-14T15:07:21.227000

Create type links to other version of the standard library with Sphinx napoleon

299 views Asked by Jarno At 14 June 2016 at 15:07

TechQA.

List Question

Custom PyCharm docstring stubs (i.e. for google docstring or numpydoc formats)

sphinx warning: autosummary: stub file not found for the methods of the class. check your autosummary_generate settings

Napoleon overescapes trailing underscore in parameter name leading to Unknown target name error

Is there a standard format for documenting function-type parameters in Sphinx using sphinx.ext.napoleon?

Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention

Using array-like as a type in napoleon without warning

Sphinx: how to show attributes as in scipy

Documenting class attributes with type annotations

how to correctly add nested list in numpy docstring in combination with sphinx docstring

Docstrings are not generated on Read the Docs with Sphinx autodoc and napoleon extensions

Autoappend Returns None to Sphinx Documentation

Sphinx 1.4+ and block literals in Returns with sphinx-napoleon don't work anymore

List of class methods with Napoleon Sphinx extension using NumPyDoc style

Sphinx fails when generating documentation for Django project

Intersphinx Docstring Readability

Sphinx and Numpydoc throws parse error when inheriting from third party package

Text outside parameters section in sphinx

Sphinx autosummary "toctree contains reference to nonexisting document" warnings

Simple way to convert Python docstrings from reStructured Text to Google style?

Create type links to other version of the standard library with Sphinx napoleon

Popular Questions

Popular Tags

Trending Questions