pdoc

pdoc copied to clipboard

### Expected Behavior Dataclass arguments/attributes should display as instance variables ### Actual Behavior Instead they appear as `static` variables ### Steps to Reproduce 1. Create a simple dataclass. e.g. ```python...

amin-nejad

Include pages (e.g. notebooks)

8

It would be nice to be able to include pages to the docs with the same menu as in the index. ### Expected Behavior ...

Vayel

I am not a fluent Python programmer. I mostly use standalone .py scripts, which sometimes call functions from other .py scripts. But they are not structured into modules, projects or...

abubelinha

enable showing private methods/variables

2

### Expected Behavior Would like to see private methods/variables in the documentation ### Actual Behavior Methods and variables that begin with "_" are excluded. ### Steps to Reproduce 1. Generate...

mkinney

ENH: Add support for reST-style docstrings

8

Hi kernc and all contributors, Addressing issues #110 and #273, I added support for reST-style docstrings, following your suggestions in #198. Additionally, in case the docformat is not explicitly specified,...

devdrian

The idea for documenting reimported entities from submodules

5

Hi! - I have a function `my_lib.my_module.my_function` - I do `from .my_module import my_function` in `my_lib/__init__.py` - I want users to access the function as `my_lib.my_function` As far as I...

Yura52

documentation root folder and links to child pages

1

I'm working on [calib3d python GitHub repository](https://github.com/ispgroupucl/calib3d) Documentation is generated with ``` pdoc calib3d -o docs/ -c latex_math=True --force --html ``` GitHub pages is configured so that documentation points to...

gabriel-vanzandycke

Can you publish a wheel as well as the sdist?

2

Where I work would like us developers to use the stricter installation protocol of only using wheels, they don't have to run arbitrary code on installation. I can't do a...

matthewdeanmartin

When using "from __future__ import annotations", linking of types stops working. I believe this is because the behaviour of inspect.signature changes to returning only the string form of the class...

blaisethom

Generate docs of project fails with virtual environment dependencies

5

Adapted from the pdocs [programmed recursive documentation generation](https://pdoc3.github.io/pdoc/doc/pdoc/#programmatic-usage) example, I have a script that runs the following methods: tl_util.py ```python import pdoc # documentation def pdoc_module_path(m:pdoc.Module, ext:str='.html', dir_path:str=DOCS_PATH): return os.path.join(...

ogallagher