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.
Questions tagged [pdoc]
43 questions
1
vote
1 answer
Pdoc adds class info to every enum variable
I don't know what exactly is going on, I don't have that great of an understanding of Pdoc but I am using it to create documentation of my source code. It usually works pretty well but I recently stumbled into a problem when documenting classes…
Lone Lunatic
- 805
- 8
- 20
1
vote
1 answer
How to use pdoc on a script that takes command line args?
I'm trying to use pdoc to document my python script but I'm having an issue due to the fact that my program requires the use of command line args.
My program is called as follows: myprogram.py -p arg1 -s arg2
And I try to run pdoc as follows: pdoc…
Swoldier
- 155
- 5
- 19
1
vote
2 answers
pdoc - No module named xxx
I am trying to create a normal .html file with pdoc, but I'm getting a error message.
File 1: gui.py
# -*- coding: utf-8 -*-
"""gui test"""
# Form implementation generated from reading ui file 'gui.ui'
#
# Created by: PyQt4 UI code generator…
user5032885
0
votes
0 answers
pybind11 documenting issue of python embedded module in c++ application
We have an embedded python interpreter in C++ MFC application.
The issue is when I request a help of a wrapped C++ lambda function I see ellipsis in arguments:
help(my_module.test)
prints:
test(...) method of builtins.PyCapsule instance
some…
evguran
- 1
- 1
0
votes
1 answer
How do I resolve No Modules found matching spec when running pdoc (in Windows)?
I'm trying to run the simple demo script from pdoc documentation in windows from the command line. Using python 3.11.4 with virtualenv and PYTHONPATH set to folder in question.
"""
A small `pdoc` example.
"""
class Dog:
""" (dog) """
name:…
bobgott
- 159
- 1
- 11
0
votes
0 answers
Add a filter/classifier to the Python function for generating documentation for custom tags
I want to generate the documents for my Python project.
I know that there are a lot of useful tools that I have read about, such as pdoc and Sphinx.
One of my biggest requirements is that I want to add a tag or classifier for some functions located…
codebrew
- 329
- 2
- 13
0
votes
0 answers
How to continue to document other code cells of jupyter notebook with pdoc
I have a code that you can select a jupyter notebook file(by panel) then this code put every cells in seperate python files, for example cell number 1 in 1.py cell number 2 in 2.py and..., after that with pdoc command we create document for each…
Samira
- 1
- 1
0
votes
0 answers
How to programmatically create new cell in source jupyter notebook and load the file on it
I would like to find the code type cells of the particular jupyter notebook and when I find this cell then create new cell after that and copy the google docstring documentation of that cell to the new cell, I did it as follows:
with the following…
Samira
- 1
- 1
0
votes
2 answers
How to activate Python env in the local directory and run pdoc with pre-commit?
I have recently created a GitHub Actions workflow to lint/reformat the code of my repo and create documentation HTML pages using pdoc. The last step is problematic, because pdoc runs the .py files to create the documentation. For one of the files…
jordp1
- 1
- 3
0
votes
1 answer
Python Github pdoc - ModuleNotFoundError: No module named mainFile
I have two files: mainFile.py and test_mainFile.py. I am trying to generate a documentation using pdoc which works well in a command line, but when I try to do the same thing using GitHub Actions, it fails to find the file.
Run if [ -f __init__.py…
Filip Z
- 59
- 5
0
votes
0 answers
python pdoc the whole project
lately i've started using pdoc3 to document my whole project,
right now i have a problem generating a HTML that contain the whole project in 1 command, and not going every.py file one by one
the project structure is like this:
--pythonProject
| …
GiiR
- 1
- 1
0
votes
0 answers
Using docstrings with Cython - attribute not found in module error
I am trying to use documentation using docstrings- my code is written in cython and compiles fine normally
When I try to run
pdoc --http localhost:8080 main.pyx
I get a bunch of errors such as
module 'mongo' has no attribute…
erixliechtenstein
- 301
- 4
- 16
0
votes
1 answer
Can single pdoc generated pages document APIs spread over multiple files?
I have a Python package which is spread over multiple files:
package/__init__.py
package/thing_a.py
package/thing_b.py
package/thing_c.py
package/submodule/__init__.py
package/submodule/...
The thing_XXXs break apart chunks of internal code into…
0
votes
1 answer
Doxygen -> Doxy2Swig -> pdoc results in duplicate class docstrings
I have a C++ header file (.h) that (through swig) I generate a python module for. My goal is to include the Doxygen documentation from the .h file in the generated .py file, but since I am currently unable to use the latest swig (v4+) that supports…
Paige
- 33
- 4
0
votes
1 answer
Pdoc doesn't recognize Google-Style
I am trying to use the google-style directive with pdoc, but it doesn't work on my side.
Where am I wrong? Below is my code.
Please help me.
:)
def save(a: str, b:str) -> set:
"""
Do something
Args:
…
sam
- 19
- 1
- 4