Popular recipes tagged "documentation"

A simple Unix shell utility to save cleaned-up man pages as text (Bash)

2017-03-25T14:12:25-07:00

Bash recipe 580766 by Vasudev Ram (bash, documentation, man, script, shell, utilities, utility).

It's a shell script that lets you save the man pages for one or more Unix commands, system calls or other topics, to text files, after cleaning up the man command output to remove formatting meant for emphasis, printing, etc.

More information here:

https://jugad2.blogspot.in/2017/03/m-unix-shell-utility-to-save-cleaned-up.html

Get names and types of all attributes of a Python module (Python)

2016-10-06T17:21:42-07:00

Python recipe 580705 by Vasudev Ram (documentation, introspection, modules, reflection, type).

This recipe shows how to get the names and types of all the attributes of a Python module. This can be useful when exploring new modules (either built-in or third-party), because attributes are mostly a) data elements or b) functions or methods, and for either of those, you would like to know the type of the attribute, so that, if it is a data element, you can print it, and if it is a function or method, you can print its docstring to get brief help on its arguments, processsing and outputs or return values, as a way of learning how to use it.

The code for the recipe includes an example call to it, at the end of the code. Note that you first have to import the modules that you want to introspect in this way.

Autogenerate API docs in Markdown (Python)

2009-04-28T23:11:26-07:00

Python recipe 576733 by geremy condra (documentation, markdown). Revision 2.

markdowndoc is a pydoc extension that allows you to autogenerate API docs for websites that use Markdown. We specifically developed it with Gitorious's wikis in mind, but it should work for other wikispaces and, of course, ActiveState. You can see a few examples of it here.