pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
pdoc3 works really fantastic, but can i use the material for mkdocs theme ? Is it possible now ? or may be in future ? Many thanks for your help
Pydoc currently does not indicate in any way that a function or other object has a decorator. But decorators are often used to change or add to the way how...
With [Python 3.5.x having reached its end of life/support](https://www.python.org/downloads/release/python-3510/), we can begin to use ["advanced" features from Python 3.6](https://docs.python.org/3/whatsnew/3.6.html#summary-release-highlights): * [f-strings](https://www.python.org/dev/peps/pep-0498/) * [variable annotations](https://docs.python.org/3/whatsnew/3.6.html#whatsnew36-pep526) over type comments https://github.com/pdoc3/pdoc/blob/651d1a8d7bf0c8964839dd1997227ab11f57df24/pdoc/__init__.py#L249-L250 Additionally: *...
```python def func(s, test): """ Returns `True` if the string length is greater than the given integer. :param s: str :param test: int :return: bool """ pass ``` This is...
### Expected Behavior A global variable not included in `__all__` but whitelisted in `__pdoc__` is included in the documentation. ### Actual Behavior It is not. ### Steps to Reproduce 1....
### Expected Behavior I am looking for some configuration switch to tell Python Markdown which extensions to use, specifically something like [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions) to enable task-lists and strike-through. ### Actual...
### Expected Behavior Within a class-level docstring (or even better also any docstring in a class method), class method names in backticks should generate links to that method. ### Actual...
In addition to the module-documentation pages generated by the `pdoc` command-line utility, I would like to create an introduction page for the distribution package as a whole (as opposed to...
### Expected Behavior All latex formulars are shown correctly, or be abbreviated correctly. ### Actual Behavior Long latex formulas from ancestor classes are not shown correctly. It depends on the...
I am keeping my python implementation details in a package called `_internal` and export the methods, classes and variables that are supposed to be the public API by re-exporting them...
