Stack Overflow
Stack Overflow

Questions tagged [pdoc]

pdoc - A simple command line tool and library to auto generate API documentation for Python libraries.

pdoc - A simple command-line tool and library for auto-generating API documentation for Python projects.

https://pdoc.dev/

43 questions
0
votes
1 answer

customising pdoc automatically generated documentation for python

I used pdoc3 to automatically generate documentation from the docstrings at the beginning of each python class/function by executing the following pdoc3 --html ambit_stochastics The resulting documentation can be found at…
Dan Leonte
  • 131
  • 2
0
votes
0 answers

How do I document a parameter that is exclusively passed to another function?

Suppose I have two functions: def func_a(x, passed_parameter): """ Return ... Args: x: ... passed_parameter: Do a specific thing. """ ... def func_b(passed_parameter): """ Return ... …
Kraigolas
  • 5,121
  • 3
  • 12
  • 37
0
votes
1 answer

pdoc does not generate the function arguments as links

I am using pdoc3 in order to generate my project docs. The project is composed from 2 py modules: api.py model.py The data structures are defined in model.py and used in api.py. The generated HTML does not generate the function arguments as…
balderman
  • 22,927
  • 7
  • 34
  • 52
0
votes
1 answer

How to hide 3rd party imports from pdoc?

What is the proper way to hide imports from a documentation generator like pdoc? Specifically, what is best practice for generating docs on adhoc scripts? For example: import someThirdPartyLibrary def main(): …
ProGirlXOXO
  • 2,170
  • 6
  • 25
  • 47
0
votes
1 answer

Python, Google style docstrings: Define an argument or return type as a sublcass of another type?

How is one supposed to document that an argument, or return type, is intended to be a subclass of a particular type using Google style docstrings? This how I suggest a subclass when using type hints. from typing import TYPE_CHECKING, Type ... if…
conner.xyz
  • 6,273
  • 8
  • 39
  • 65
0
votes
0 answers

SQLAlchemy error when autogenerating documentation for database module using pdoc3

I'm creating documentation for a project using pydoc3 but am encountering an odd error from SQLAlchemy when running against my database module. Background Project layout: PROJECT_NAME/ |-- __init__.py | |-- api | |-- main.py | |-- database | |--…
Yaakov Bressler
  • 9,056
  • 2
  • 45
  • 69
0
votes
2 answers

pip isn't recognizing PIL

This is a very leveled problem. I was using pdoc to create some documentation for my library, which uses PIL for image processing. Everything worked fine, except the module that used PIL, where it threw the following Traceback (most recent call…
Nathan Wolf
  • 336
  • 3
  • 12
0
votes
1 answer

How to generate documentation for python project including private/protected classes with pdoc

I am trying to generate documentation for my python project with pdoc module by following this article. I noticed that all the classes, methods, etc starting with __ (private/protected ones) are missing in the generated documentation. This is the…
npatel
  • 1,081
  • 2
  • 13
  • 21
0
votes
1 answer

How to automatically generate docstrings including nested functions?

How to generate automatically docs for the c_nested function? Background: I do code documentation for other developers and I would like to automatically generate a summary of all class methods included nested functions with short description…
Dan
  • 437
  • 7
  • 24
0
votes
1 answer

Document functions from different modules using pdoc

I've got two modules: first_module containing functions a, b and c second_module containing functions d, e and f I would like to generate an HTML documentation using pdoc such that it doesn't document both modules in whole, but rather contains only…
Pat Res
  • 97
  • 1
  • 7
0
votes
1 answer

Pdoc - Change template directory programatically

I have a script that generates documentation using pdoc for all of my classes in my project. I want to further customize my documentation by making changes to pdoc templates. I want to do this inside of my project so I can track changes in git,…
AronAtVW
  • 115
  • 1
  • 2
  • 11
0
votes
0 answers

pdoc doesn't highlight parameter in docstring

If I generate a html page with python -m pdoc --html module.py the output will look like https://i.stack.imgur.com/bzDjk.png Is there a parameter to get the :param entries in the docstring somehow highlighted?
oldenstreeter
  • 13
  • 7
0
votes
0 answers

automatic xml documentation generation of decorators in python3

I am using decorators on classes in my python code. I need to generate some xml which contains which classes have which decorators, which module they are in, and what are the globals in those modules. I have tried all major documentation generators,…
Árpád Magosányi
  • 1,394
  • 2
  • 19
  • 35
1 2
3