Documenting python script entry (name == 'main') using sphinx

Question

Is there a way, ideally using autodoc, to get sphinx to document a Python script? The section of the script I want documented is the portion protected by:

if __name__ == '__main__':

i.e. the bit that only runs if the module is used as a script instead of being imported.

I tried putting in a docstring just below the test. I finally 'saw the light' and used the strategy below (function). — Papadeltasierra
– Papadeltasierra, Commented Jul 14, 2015 at 7:47

Daniel Roseman · Accepted Answer · 2015-06-11 12:13:19Z

6

You should extract the code in that block into a function, with a docstring, and call that function from the block.

answered Jun 11, 2015 at 12:13

Daniel Roseman

602k68 gold badges910 silver badges923 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Documenting python script entry (name == 'main') using sphinx

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related