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

Pythonhosted/ReadTheDocs and the future of Pdoc #173

Open
karimbahgat opened this issue Sep 14, 2018 · 2 comments

Comments

Projects
None yet
2 participants
@karimbahgat
Copy link

commented Sep 14, 2018

I'm a big fan of the simplicity of Pdoc and have up to now used it for my projects. However, this was always reliant on being able to upload the custom HTML output to pythonhosted.org. But now it seems pythonhosted.org is being deprecated in favor of ReadTheDocs (not allowed to manually upload new docs on the website, and distutils upload_docs no longer allowed and suggests switching to RTD).

Not knowing any other doc hosting services I started looking into ReadTheDocs, but it seems they only allow either Sphinx documentation or MkDocs documentation (which so far doesn't seem to have any auto construction of API docstrings).

What does this mean for the future of pdoc? Am I understanding this right? Or is there a way around it where ReadTheDocs would accept the custom HTML created by pdoc? Or maybe any other doc hosting websites?

@karimbahgat karimbahgat changed the title ReadTheDocs and the future of Pdoc Pythonhosted/ReadTheDocs and the future of Pdoc Sep 14, 2018

@kernc

This comment has been minimized.

Copy link
Contributor

commented Sep 14, 2018

Or maybe any other doc hosting websites?

One could host your project website and docs on GitHub Pages like many other projects do.

@karimbahgat

This comment has been minimized.

Copy link
Author

commented Sep 14, 2018

Thanks. Just realized that too. Just had to place the output files into a «docs» folder and specify that location in the repository settings. Works great.

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.