pdoc

pdoc copied to clipboard

pdoc adds numpy functions to the html of one of my modules

2

Hi! I just installed pdoc3 in an Anaconda virtual environment and generated the htmls of a group of modules. The html are all generated but I get the next user...

jsanchez679

__pdoc__ is not ignoring variables

2

I can get `__pdoc__` to ignore modules, but adding the variable/function name in the form `module.variable` has no effect. - pdoc version: 0.9.2

tjwebb

Allow users to invoke pdoc CLI with `python -m pdoc`

2

This is a question and/or enhancement request. I would like to invoke the `pdoc` CLI via something like ```python python -m pdoc --html MyCode ``` Is this possible? I ask...

standarddeviant

HTTP Server doesn't detect changes if __all__ is used

2

### Expected Behavior I expect changes to be reflected when using the web server when I make changes to files, even though I use `__all__ `and view the module. ###...

thomasfrederikhoeck

pdoc3 does not generate html output

11

### Expected Behavior As per the information in [here](https://pdoc3.github.io/pdoc/doc/pdoc/#command-line-interface) I was expecting the documentation to be placed inside the `html` folder. ### Actual Behavior Is not happening. ### Steps to...

laimaretto

Programmatically access markdown

3

I would like to access the markdown formatted documentation programmatically. I understand that I could provide my own .mako files overwriting "text.mako" for example, but I was wondering if there...

JannikKlauke

Local image not copied over to output directory

1

### Expected Behavior When adding a local image (relative path) to the Python Docstring like this: ```python """ # Test .. image:: test.svg """ ``` then the image should be...

fr34q

Generate module doc from pybind11

6

Hi, I was trying to generate a simple api doc from a pybind11 implementation. After multiple attempts, the issue seems to be related to the signature while generating the module...

youliangtan

Warning generated for `__pdoc__[submodule] = False`, but behaviour correct

4

### Expected Behavior I expect no warnings. ### Actual Behavior ``` /python3.8/site-packages/pdoc/__init__.py:706: UserWarning: __pdoc__-overriden key 'module' does not exist in module 'mwe' warn('__pdoc__-overriden key {!r} does not exist ' ```...

MPvHarmelen

Show short submodule names in TOC

2

Sorry for asking a very basic question but I've done some research & no result. Here's my folder structure: main-long-name-folder |--modules |----|--helper.py |--test.py I'm using some functions in `helper.py` like...

jackblk