localhost:8080 loads forever
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
- pdoc3 at least loads up a the top-lv documentation on localhost
Actual Behavior
- localhost:8080 loads forever
Steps to Reproduce
1.run pdoc --template-dir .\docs\config\ --http : .\spotdl\ from the root of this repo
Additional info
-
pdoc version: 0.9.2
-
I essentially want the
spotdl.defaultssubpackage to be rendered, runningpdoc -http : spotdl.defaultsinsteads loads up the installed version of spotdl (a modified personal copy of spotDL/spotify-downloader) -
It works just fine for every other package I've tried so far
Local CLI Output
PS D:\Projects\Code\spotdlRedesign> pdoc --template-dir .\docs\config\ .\spotdl\
d:\software\python3-9-1\lib\site-packages\pdoc\cli.py:532: UserWarning: Couldn't read PEP-224 variable docstrings from <Module 'spotdl'>: could not get source code
modules = [pdoc.Module(module, docfilter=docfilter,
d:\software\python3-9-1\lib\site-packages\pdoc\__init__.py:708: UserWarning: Couldn't read PEP-224 variable docstrings from <Module 'spotdl.defaults'>: could not get source code
m = Module(import_module(fullname),
Module spotdl
=============
Sub-modules
-----------
* spotdl.defaults
Traceback (most recent call last):
File "d:\software\python3-9-1\lib\runpy.py", line 197, in _run_module_as_main
return _run_code(code, main_globals, None,
File "d:\software\python3-9-1\lib\runpy.py", line 87, in _run_code
exec(code, run_globals)
File "D:\Software\Python3-9-1\Scripts\pdoc.exe\__main__.py", line 7, in <module>
File "d:\software\python3-9-1\lib\site-packages\pdoc\cli.py", line 583, in main
_generate_lunr_search(
File "d:\software\python3-9-1\lib\site-packages\pdoc\cli.py", line 416, in _generate_lunr_search
with _open_write_file(path.join(main_path, 'index.js')) as f:
File "d:\software\python3-9-1\lib\ntpath.py", line 78, in join
path = os.fspath(path)
TypeError: expected str, bytes or os.PathLike object, not NoneType
When I use the --http : flag, nothing happens, localhost:8080 just loads forever (a very long time)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the reported pdoc --template-dir ... --http : ... command from the issue and inspect pdoc/cli.py, especially _generate_lunr_search at the traceback location and the CLI entry point. Compare the HTTP path with the normal documentation-generation path; done means the local server responds at localhost:8080 and renders the requested spotdl.defaults documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100