File tree Expand file tree Collapse file tree 1 file changed +6
-5
lines changed Expand file tree Collapse file tree 1 file changed +6
-5
lines changed Original file line number Diff line number Diff line change 1
1
# doc2md.py
2
2
3
3
pydocmd generates Python documentation in the Markdown (md) format. It was
4
- written to automatically generate documentation that can be put on Github or Bitbucket wiki pages. It is initially based on Ferry Boender's [ pydocmd] .
4
+ written to automatically generate documentation that can be put on Github
5
+ or Bitbucket wiki pages. It is initially based on Ferry Boender's [ pydocmd] .
5
6
6
7
It is as of yet not very complete and is more of a Proof-of-concept than a
7
8
fully-fledged tool. Markdown is also a very restricted format and every
8
9
implementation works subtly, or completely, different. This means output
9
- may be different on different converters.
10
+ may be different on different converters.
10
11
11
12
* __ Author__ : blasterbug
12
13
* __ Version__ : 0.2b
@@ -16,14 +17,14 @@ may be different on different converters.
16
17
17
18
$ python doc2md.py module [...]
18
19
19
- doc2md.py scan every python files (.py) given and generate the documentation in
20
- a subfolder ` doc `
20
+ doc2md.py scans every python file (.py) given and generates the documentation
21
+ in a subfolder ` doc ` .
21
22
22
23
## Example output
23
24
24
25
- [ blasterbug/SmileANN/wiki/neuron] ( http://github.com/blasterbug/SmileANN/wiki/neuron )
25
26
- [ blasterbug/SmileANN/wiki/faces] ( http://github.com/blasterbug/SmileANN/wiki/faces )
26
- - [ blasterbug/pydocmd/wiki/pydocmd ] ( http ://github.com/blasterbug/pydocmd /wiki/pydocmd )
27
+ - [ blasterbug/pydocmd/wiki/doc2md.py ] ( https ://github.com/blasterbug/doc2md.py /wiki)
27
28
28
29
29
30
[ pydocmd ] : https://github.com/fboender/pydocmd
You can’t perform that action at this time.
0 commit comments