PyDoctor as generator on ReadTheDocs?
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Hi, I'm using pydoctor locally. ReadTheDocs.org do use Sphinx by default. But looking into the docs it seems to me that it should be possible to use every other tool to generate HTML out of your source code. Am I right? Does anyone knows a project using PyDoctor on ReadTheDocs? This question is specific to PyDoctor without(!) Sphinx involved. I do know that even youself do use Sphinx for the PyDoctor docu instead of using pure-PyDoctor. No Sphinx! Sphinx would not be an option not even in combination with something else. ;) Maybe asking the other way around: Are there alternatives to ReadTheDocs? Kind Christian
![](https://secure.gravatar.com/avatar/e1554622707bedd9202884900430b838.jpg?s=120&d=mm&r=g)
I am not aware of any project doing this specifically, but I am pretty sure you can use 'build.commands' to arbitrarily run whatever documentation generator you want on RTD. Try this, maybe? https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands -g
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Hello Folks, I got it run and can confirm it works. Am 27.12.2022 15:19 schrieb c.buhtz@posteo.jp:
Does anyone knows a project using PyDoctor on ReadTheDocs?
The config is here: https://codeberg.org/buhtz/buhtzology/src/branch/develop/.readthedocs.yaml And the result here: https://buhtzology.readthedocs.io/en/develop/ What is still missing is triggering the doc build on every new commit. I don't know how to realize this. Maybe this isn't possible because I'm using a Gitea-based hoster (Codberg.org) instead of proprietary Microsoft GitHub.
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
On Thu, 29 Dec 2022 at 07:08, <c.buhtz@posteo.jp> wrote:
RTD should support Gitea, from what I see in the docs https://docs.readthedocs.io/en/stable/integrations.html#gitea You can always use the RTD HTTP API to trigger builds See https://docs.readthedocs.io/en/stable/integrations.html#using-the-generic-ap... But this is RTD question and not a Twisted question. You can try to get support for RTD over https://gitter.im/readthedocs/community Regards -- Adi Roiban
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Dear Adi, thanks for replying. Am 29.12.2022 12:13 schrieb Adi Roiban:
RTD should support Gitea, from what I see in the docs https://docs.readthedocs.io/en/stable/integrations.html#gitea
This part of the doc is outdated and doesn't fit the current stable UI.
Now sure how this can help? IMHO this is a "message service" to inform extern instances about a new doc build. I need it the other direction.
But this is RTD question and not a Twisted question.
Correct. The search goes on here: https://stackoverflow.com/q/74931717/4865723
You can try to get support for RTD over https://gitter.im/readthedocs/community
Quit inactive there.
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
On 2022-12-29 07:07 c.buhtz@posteo.jp wrote:
How to configure a commit-trigger-autobuild between Codeberg/Gitea and RTD is explained here https://stackoverflow.com/a/74959815/4865723
![](https://secure.gravatar.com/avatar/e1554622707bedd9202884900430b838.jpg?s=120&d=mm&r=g)
I am not aware of any project doing this specifically, but I am pretty sure you can use 'build.commands' to arbitrarily run whatever documentation generator you want on RTD. Try this, maybe? https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands -g
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Hello Folks, I got it run and can confirm it works. Am 27.12.2022 15:19 schrieb c.buhtz@posteo.jp:
Does anyone knows a project using PyDoctor on ReadTheDocs?
The config is here: https://codeberg.org/buhtz/buhtzology/src/branch/develop/.readthedocs.yaml And the result here: https://buhtzology.readthedocs.io/en/develop/ What is still missing is triggering the doc build on every new commit. I don't know how to realize this. Maybe this isn't possible because I'm using a Gitea-based hoster (Codberg.org) instead of proprietary Microsoft GitHub.
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
On Thu, 29 Dec 2022 at 07:08, <c.buhtz@posteo.jp> wrote:
RTD should support Gitea, from what I see in the docs https://docs.readthedocs.io/en/stable/integrations.html#gitea You can always use the RTD HTTP API to trigger builds See https://docs.readthedocs.io/en/stable/integrations.html#using-the-generic-ap... But this is RTD question and not a Twisted question. You can try to get support for RTD over https://gitter.im/readthedocs/community Regards -- Adi Roiban
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Dear Adi, thanks for replying. Am 29.12.2022 12:13 schrieb Adi Roiban:
RTD should support Gitea, from what I see in the docs https://docs.readthedocs.io/en/stable/integrations.html#gitea
This part of the doc is outdated and doesn't fit the current stable UI.
Now sure how this can help? IMHO this is a "message service" to inform extern instances about a new doc build. I need it the other direction.
But this is RTD question and not a Twisted question.
Correct. The search goes on here: https://stackoverflow.com/q/74931717/4865723
You can try to get support for RTD over https://gitter.im/readthedocs/community
Quit inactive there.
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
On 2022-12-29 07:07 c.buhtz@posteo.jp wrote:
How to configure a commit-trigger-autobuild between Codeberg/Gitea and RTD is explained here https://stackoverflow.com/a/74959815/4865723
participants (3)
-
Adi Roiban
-
c.buhtz@posteo.jp
-
Glyph