-
Please have a look at result of
```shell
pydocmd simple abalon.spark.sparkutils+ > README.md
```
and result rendered at
https://github.com/Tagar/abalon
- notice :param: arguments are all tog…
Tagar updated
5 years ago
-
Cool repo! I like it a lot, but I noticed that markdown is only generated for functions which contain a """ string after the def line. For a number of functions this doesn't exist but I'd like to gene…
-
pydocmd seems currently to lack support for documenting constant values.
As a test I added a new constant to `testmodule.__init__`:
```python
EXAMPLE_CONSTANT_VALUE = 42
```
I built docs fo…
-
I'm referring to this line:
https://github.com/NiklasRosenstein/pydoc-markdown/blob/master/pydocmd/preprocessor.py#L69
This breaks if the line contains another colon, i.e. in a url. E.g. the li…
ghost updated
5 years ago
-
Hi! Thanks a lot for making pydoc, after many hours struggling with other tools this one fits pretty well my workflow in a very simply manner. However, I found pretty strange that some html headers `H…
-
With the function:
```python
def add(a, b):
"""Add two numbers.
# Arguments
a (int): First number
b (int): Second number
# Example
This text is rendered as code…
-
```
File "./pydoc_markdown/__init__.py", line 135, in write_class_member
prefix = type_.__name__
NameError: name 'type_' is not defined
```
I believe this is supposed to be tpe instead of t…
-
With Pydocmd it doesn't seem to be easy to document constants or dictionaries with docstrings (it seems to be possible with Sphinx or using module docstrings).
One option could be to document them …
-
Continued from #108
-
I have a small framework in Django ORM's style which has entities classes that consist of fields. Fields are built as Python's descriptors. I want to use your tool for the entities doc generation, but…
AuHau updated
5 years ago