-
_From [elron...@gmail.com](https://code.google.com/u/112796493857278763022/) on January 06, 2011 11:34:19_
Docs desperately need some additional features / updates / fixes:
- Way to show all / inheri…
-
document required and optional API functions
-
With the latest versions of python-vlc and pylint, I am getting various SyntaxWarning(s) just by importing the vlc library:
**test.py**
```python
import vlc
```
**pylint output**
```
$ pyth…
-
Sphinx is a pretty easy to use way to document python projects.
-
Some docstrings contain type info (as opposed to stubs or type annotations). This info should be parsed and used best-effort.
There are many different possible formats; numpy, google, epydoc, etc.
…
-
DAUX does not support generating API documentation. For this we should edit our comments to be compatible with a standalone API documentation generator project like [pydoctor](https://launchpad.net/py…
-
```
From a Menu -> Help -> User Manual.
Some format for ideas ?
- XML Docbook
- latex like for the python standard library (look for the aspen project
and get their doc code).
- Restructured text…
-
Analogous to the [Zen of Python](https://www.python.org/dev/peps/pep-0020/), I thought it might be useful to have some guiding principles to make it easier to make design decisions.
## System-agnostic…
daler updated
8 years ago
-
At numerous points in the [web documentation](http://eliot.rtfd.org), it would be useful to link to API documentation that outlines the types and parameters. Right now, I find that I have to have the …
-
Instead of hand-writing API docs, could you please release XSDs for your API? I just spotted all IQs begin with xmlns definitions like ``. This can save a lot of work if these schemas are already defi…