pdoc

pdoc copied to clipboard

Support for multiple versions of a package

9

#### Problem Description Currently, `pdoc` only supports one version of a given Python package. #### Proposal I would like to see (optional) support for multiple versions of a package in...

JCGoran

Same `Headline` and Method Name Causes Identical HTML Anchors -> Cannot Jump to Method Documentation Anymore

1

Having - a method named `my_method_one` and - a headline ```markdown `my_method_one` ``` causes pdoc to generate to create two html elements with the same id `id="my_method_one"`, which is invalid...

lovetheguitar

Inline Math doesn't seem to support escapes with backslash

2

#### Problem Description When using the inline Math syntax `:math:`, it doesn't seem to be possible to escape curly brackets or underscores with a backslash. #### Steps to reproduce the...

Loitador41

Extend Google list sections with more section types

2

The Google list sections recognises currently only _"Args"_, _"Raises"_ and _"Attributes"_ as headers for sections that consist of a definition list. This could be extended to recognise more section headers,...

mensonen

reST: Support explicit titles for cross-references

6

#### Problem Description I would like to `.. include:: ../README.rst` in my `__init__.py` module docstring. However, it appears to be parsed as markdown, despite the fact that it has the...

rhelmot

Exclude some files completely?

2

#### Problem Description I've got some Python 2.7 stuff in my project and while they function fine in the intended environment (Maya), pdoc can't execute them under 3.9 and I...

AronDurkinSSS

Support for typing @overload annotation

4

#### Problem Description Some support for function overloads specified by `@overload` annotation in typestubs is missing. All functions that have it, are just shown with the general base implementation `(*args,...

jpfeuffer

#### Problem Description ```bash AssertionError: OSError: If there is an error while writing to the file. ``` Is raised, when I run `pdoc` with the following flags ```bash pdoc --math...

MartinRJDagleish

Add options for include directive

1

Adds support for the `start-*` and `end-*` options of the rst `include` directive. Closes #682.

frankharkins

Way to add external Markdown file

2

first of all, thanks, pdoc is amazing! #### Problem Description I have a CHANGELOG.md file that doesn't fit to any particular function documentation. I want to create an extra page...

kidpixo