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
7
votes
0 answers
how to display HTML files on BitBucket?
We currently use GitHub for our code repos, which include HTML files for documentation. On GitHub, the HTML files in the repo only display the HTML source, but I can publish it to GitHub Pages, where it displays as a regular web page for my…
dcafdg
- 163
- 2
- 6
6
votes
1 answer
How do I make pdoc preserve whitespace?
I'm trying to generate documentation using pdoc, where my docstrings look like this:
"""
I am a description of what a method does
:param param1: an integer
:param param2: a str
"""
I found this question: How to preserve line breaks when generating…
Colleen
- 23,899
- 12
- 45
- 75
3
votes
1 answer
Pydoc not finding installed modules
I am trying to generate HTML documentation using pydoc. The project is divided in several subfolders, all of them containing __init__.py files.
The content of __init__.py in my main folder is as follows:
import sys
sys.path.insert(1, '.')
I can run…
Irina
- 1,333
- 3
- 17
- 37
3
votes
1 answer
Method parameters not formatted correctly in pdoc generated HTML
I have a method in a class defined as shown below:
def my_method(self, a: str = None, b: str = None) -> typing.Set[str]:
"""
Do something
:param a: A string to represent something.
:param b: A string to represent something else.
…
ubiquibacon
- 10,451
- 28
- 109
- 179
3
votes
2 answers
Create a html page with a list of packages using pdoc module?
I have prepared a simple code that creates an html page from a Python (*.py, or *.pyc) script using the pdoc module. The code is the following:
def make_pdoc():
import pdoc
import sys
from os import path
libpath =…
Premysl Vorac
- 473
- 6
- 16
3
votes
3 answers
pdoc can't import the function from other module
i'm using python 2.7 and trying to gather documentation for our testing project using pdoc.
pdoc is located here: D:\dev\Python27\Scripts
the regression project here: C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Tests
We…
Maria
- 31
- 1
- 4
2
votes
1 answer
pdoc3 ValueError: File or module 'xxx' not found if imported from other package
pdoc3 is a nice tool to generate documentation from code. In one of my projects, I got some exception. Wonder if it is caused by project structure. These are the folder structure of my two projects.
proj_A
-src
-automation
-hl7ctl
…
thsieh
- 620
- 8
- 24
2
votes
3 answers
pdoc3- ValueError: File or module not found
I'm using pdoc to generate documentation for one of my projects. This is my file structure-
my_project
|- files
|- logs
|- scripts
|- __init__.py
|- main_script.py
|- script_one.py
..where the main_script.py imports script_one.py and a few…
kev
- 2,741
- 5
- 22
- 48
2
votes
1 answer
Python Pdoc - how to export html with separate css file?
I am using pdoc function:
def html(module_name, docfilter=None, allsubmodules=False, external_links=False, link_prefix='', source=True)
But according to documentation on http://pdoc.burntsushi.net/pdoc#pdoc.html I am unable to find out how to…
matousc
- 3,698
- 10
- 40
- 65
1
vote
2 answers
Why does pdoc in pre-commit pass locally, but fail with "files were modified by this hook" in GitHub action?
Pdoc is invoked last in my pre-commit hook, it builds documentation to /docs, which is included in my repository. Files in /docs are excluded from the pre-commit hook, so the formatting hooks don't touch them.
I observe the following pattern:
I run…
jobrachem
- 105
- 7
1
vote
1 answer
pdoc3 or Sphinx for directory with nested module
My code directory looks like below. I need to generate documentation for all the modules like for sub1,sub2,submoduleA1,submoduleB1 and so on.
Also as shown for submoduleB2.py: all the modules imports from other modules/submodules
└──…
arya
- 35
- 3
1
vote
1 answer
How do I resolve ModuleNotFoundError when running pdoc in Python?
I will preface this by saying I'm still getting familiar with Python. My code executes just fine, with no errors. I have all the packages installed that I need. But when I try to create the documentation for my code using pdoc --html , I…
FulcrumFlex17
- 19
- 5
1
vote
1 answer
Making link names shorter in pdoc3 automated html documentation
I am generating html documentation via docstring and pdoc3 for the first time.
I would like to replace displayed names of qualified internal and external links, as I have seen for example in the pdoc3 documentation itself as such
A special type of…
Tom M
- 55
- 5
1
vote
1 answer
Pdoc: doesn't generate documentation
I was trying to generate documentation for my python package using pdoc, and it didn't generate any documentation when I ran the command py -m pdoc --html [package name].It outputs the error ...\Python\Python38\python.exe: No module named…
Quantalabs
- 379
- 2
- 14
1
vote
2 answers
ReadTheDocs: Publishing Pre-Built HTML Pages to ReadTheDocs
I was trying to create documentation from python doc strings, and found pdoc. If you don't know, it creates html documentation from python doc strings. Since it generates .html files and not .rst, how do I publish those to ReadTheDocs or generate…
Quantalabs
- 379
- 2
- 14