Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to generate all doc for the package test? #62

Closed
ray-sh opened this issue Aug 17, 2015 · 7 comments

Comments

Projects
None yet
5 participants
@ray-sh
Copy link

commented Aug 17, 2015

test
init.py
test1.py
test2.py

I want to generate the python doc for the package test but the following command not work, anything wrong?
pdoc --html --html-dir /tmp/test/ --all-submodules --overwrite /test/

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Aug 17, 2015

Can you please provide more details? I can't help you unless you tell me what you've observed. When you run the pdoc command, what happens? Are no docs produced? Are docs produced but empty? Are docs produced but don't contain all items you expect to see?

I'd recommend reading the "Where does pdoc get documentation from?" section at http://pdoc.burntsushi.net/pdoc

@gvvka0327

This comment has been minimized.

Copy link

commented Nov 7, 2015

I tried this very scenario above, and same command

pdoc generated "test_support.m.html" file and when I open it, it has all wiered content apart from the two python modules test1.py and test2.py

not sure, if I need to use any other parameters in the command for it to work..

@mikecharles

This comment has been minimized.

Copy link

commented Nov 8, 2015

@gvvka0327 you need to provide a sample of the output produced or we'll have no idea what actually happened

@gvvka0327

This comment has been minimized.

Copy link

commented Nov 9, 2015

command uses: pdoc --html --html-dir test_docs --all-submodules --overwrite test
attached are few screenshots during this
screenshot2
screenshot1

test,

@gvvka0327

This comment has been minimized.

Copy link

commented Nov 9, 2015

Hi Mike,

I attached the screenshot of the output generated in github... was
expecting documentation for test1.py and test2.py modules.. but instead got
some other output..

attaching here again...

[image: Inline image 1][image: Inline image 2]

Thank you,
Vijay

On Sat, Nov 7, 2015 at 7:32 PM, Mike Charles notifications@github.com
wrote:

@gvvka0327 https://github.com/gvvka0327 you need to provide a sample of
the output produced or we'll have no idea what actually happened


Reply to this email directly or view it on GitHub
#62 (comment).

@gvvka0327

This comment has been minimized.

Copy link

commented Nov 12, 2015

I resolved this issue on my end, two things to take care of,
- I need to define PYTHONPATH to the directory where this packages reside (export PYTHONPATH=/home/tests)
- Start http server with --only-pypath set (pdoc --http --only-pypath)

@mikecharles

This comment has been minimized.

Copy link

commented Nov 15, 2015

Glad you fixed it @gvvka0327

@cortesi cortesi closed this Jun 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.