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

Option to only output Markdown? #97

Closed
sanseihappa opened this issue Mar 22, 2016 · 5 comments

Comments

Projects
None yet
2 participants
@sanseihappa
Copy link
Contributor

commented Mar 22, 2016

I really like mkdocs. I really like your pdoc module. Can I get the best of both by combining with a few commands and invoking pdoc to output markdown instead of HTML?

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Mar 22, 2016

It's the default mode of operation? pdoc module will show a plain text view.

@sanseihappa

This comment has been minimized.

Copy link
Contributor Author

commented Mar 22, 2016

Hmm, maybe then I'm not invoking properly, because I don't get all the submodules... even invoking with the --all-submodules

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Mar 22, 2016

pdoc only shows documentation for one module at a time. If you're noticing differences between the HTML and plain text output, then that probably deserve a bug report.

@sanseihappa

This comment has been minimized.

Copy link
Contributor Author

commented Mar 22, 2016

The HTML output appears to be recursively constructing the sub-modules. For example:

$ pdoc --html example --html-dir html --html-no-source --overwrite
$ ls html/example/ 
index.html  SomeClass1.m.html  SomeClass2.m.html
$ pdoc example
Module example
--------------
This is a fake example package

Sub-modules
-----------
    example.SomeClass1
    example.SomeClass2

The fake example package is attached.

So, I was expecting the default text output to also include the sub-modules...
example.tar.gz

@sanseihappa

This comment has been minimized.

Copy link
Contributor Author

commented Mar 23, 2016

Essentially, for a multi-module package, should there be an --md option or something that will output files in a directory similar to the --html option?

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.