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

Support generating HTML files for the source code #477

Open
not-my-profile opened this issue Feb 4, 2022 · 4 comments
Open

Support generating HTML files for the source code #477

not-my-profile opened this issue Feb 4, 2022 · 4 comments

Comments

@not-my-profile
Copy link
Contributor

Currently Pydoctor only supports linking the source code externally via --html-viewsource-base=URL.

It would be convenient if Pydoctor could also generate HTML files for the source code, especially for the following scenarios:

  • private projects where the source code is not published online (yes you could of course set up a password protected web server or just a web server on localhost / your intranet but all of this is more effort than just having pydoctor generate the HTML)

  • even if projects are planned to be published as open source, authors might want to wait with that until the alpha is finished, until that point having pydoctor generate HTML files for the source code could be useful for development

@tristanlatr
Copy link
Contributor

Yes that’s a great feature to have.

@adiroiban
Copy link
Member

Isn't there already a shared tool that can do that? Just asking.

I know that python code coverage generates annotated HTML files for the python source code :)

@tristanlatr
Copy link
Contributor

@adiroiban
Copy link
Member

what a coincidence :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants