Tagged Questions

1
vote
1answer
150 views

Splitting documentation between docstrings and sphinx

I'm using a combination of docstrings and Sphinx to document my Python programs. With Sphinx's autodoc, I can write a lot of documentation into the source as docstrings. Is there any standard for ...
1
vote
7answers
1k views

What is the best offline reference for Python? [closed]

I'm learning Python on a computer with no access to the internet, I have the Python documentation on it but it lacks in several ways (no good introduction to threading, no examples on how to use the ...
2
votes
3answers
581 views

How should I document a Python script?

I have a couple of Python modules that are meant to be run as scripts. How should I write the docstrings at the module and function level to make it clear how to run and use the module?
3
votes
4answers
296 views

Documentation tool in one “simple” file?

Is there a tool like AsciiDoc or reStructuredText that is simple enough, like a standalone Python file, to be embedded in the repository of the associated project I'm writing documentation for? Assume ...