Skip to content

Commit 0dca539

Browse files
committed
fixes
1 parent 2a8741d commit 0dca539

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# doc2md.py
22

33
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].
56

67
It is as of yet not very complete and is more of a Proof-of-concept than a
78
fully-fledged tool. Markdown is also a very restricted format and every
89
implementation works subtly, or completely, different. This means output
9-
may be different on different converters.
10+
may be different on different converters.
1011

1112
* __Author__: blasterbug
1213
* __Version__: 0.2b
@@ -16,14 +17,14 @@ may be different on different converters.
1617

1718
$ python doc2md.py module [...]
1819

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`.
2122

2223
## Example output
2324

2425
- [blasterbug/SmileANN/wiki/neuron](http://github.com/blasterbug/SmileANN/wiki/neuron)
2526
- [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)
2728

2829

2930
[pydocmd]: https://github.com/fboender/pydocmd

0 commit comments

Comments
 (0)