173 questions
0
votes
1
answer
41
views
How to generate documentation for multiple files using pydoc
I tried to generate documentation for my python project using pydoc.
My repository looks like this:
main.py
src/
├─ cli.py
├─ ui.py
In the main.py file, I have these imports:
import argparse
import ...
0
votes
2
answers
195
views
How to access documentation of libraries like numpy, scipy etc. via pydoc offline on my workstation
Everytime, I want to access the documentation of libraries that I need for my project, I have to go to their website. Python has the excellent utility called pydoc, but I can only access the ...
- 306
0
votes
2
answers
300
views
How do I format pydoc html output?
I am trying to use pydoc to generate documentation for my code. Basically everything goes smoothly - I input my docstrings and run python -m pydoc on the module and an html file is written.
But the ...
- 59
0
votes
1
answer
102
views
How format doc within :param <name>: in reStructuredText markup?
I am trying to document certain :param and want to give examples like
:param mapper_matrix:
lookup table with columns ref_col, ref_col_2 and value.\n
|**Example:**
| ...
- 13.1k
0
votes
1
answer
107
views
pydoc error when executed on a file containing SQLAlchemy models
I'm trying to run pydoc on a Python file using my Windows machine. The file contains SQLAlchemy models, but have been struggling with an error.
I appreciate it if I can receive some guidance. Attached ...
- 1
0
votes
0
answers
98
views
Python generate documentation using pydoc
I have nested folder structure library and the question is about generating documentation from the source-code files.
Folder Structure
mylib
├── foo
├── __init__.py
│ ├── Foo....
- 2,180
1
vote
0
answers
125
views
Keep Python code safe from execution by Pydoc
This question is related to the question Stop pydoc from running my Python program, except that here I'm not actually trying to document my own code - I'm just trying to use pydoc to look up unrelated ...
- 811
1
vote
0
answers
177
views
PyDoc - Write multiple files at the same time
I am trying to use pydoc to output a series of .html files for our project's documentation, however I don't want to have to sit and do this manually so I'm trying to automate it so that pydoc will ...
- 11
-1
votes
1
answer
53
views
how to retrive methods pydoc from Generic class
Currently we use vs-code to develop and having pydocs documentation helps a lot to understand the system overall, but the IDE is returning the documentation of the interface rather than the ...
1
vote
2
answers
532
views
Extract text from first page of word document and use it as a folder name, then move the file inside that folder
I have hundreds of word documents that needs to be processed but need to organized them first by versions in subfolders.
I basically get a drop of these word documents within a single folder and need ...
- 25
0
votes
2
answers
899
views
when install any package using pip i get error can't import mapping from collection?
I work on python 3.10 i face error and i can't solve it .
this error display when try to install new package or
using any pip related command
python 3.10 already installed but can't add New Package ...
- 670
0
votes
2
answers
183
views
Python module implemented like a package
I have an application containing a package, thus:
* fruits/
| citrus/
| | __init__.py
| | oranges.py
| | mandarins.py
| | satsumas.py
| | ... etc
The Python files under fruits/citrus/ ...
- 435
1
vote
0
answers
250
views
Multi module pydoc html documentation
I create a single module html documentation using pydoc like:
pdoc --html file.py
Is it possible to generate pydoc documentation for many modules in one html file?
- 11
1
vote
0
answers
543
views
Is there a way to get pydoc to generate docs for just a module and its submodules?
I know sphinx and pdoc3 exist, but I'm trying to use pydocs despite my better judgment.
This invocation
python -m pydoc -w .\\
will
generate docs for all modules including things I don't want such ...
- 33.3k
1
vote
1
answer
103
views
Pydoc ignores opencv function, just considers python functions defined with def keyword
I want to develop API documentation for my OpenCV project.
But when I ran pydoc - w command on my module, it only created documentation for those function which are declared with the def key word.
...
