Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upPythonhosted/ReadTheDocs and the future of Pdoc #173
Comments
karimbahgat
changed the title
ReadTheDocs and the future of Pdoc
Pythonhosted/ReadTheDocs and the future of Pdoc
Sep 14, 2018
This comment has been minimized.
This comment has been minimized.
One could host your project website and docs on GitHub Pages like many other projects do. |
This comment has been minimized.
This comment has been minimized.
|
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
karimbahgat commentedSep 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?