Links to external types
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Hello, in your great epytext demo [1] I can see that types are generated as hypertext. Great! ;) But I don't get it how you did it. 1. Maybe it is a good idea to add the pydoctor call you used to generate the demos to the documentation. Or did I missed it somewhere? 2. The demo show Python types only. Is it possible to use hypertext for 3rd party-types also (e.g. pandas, numpy, ...)? [1] -- <https://pydoctor.readthedocs.io/en/latest/docformat/epytext/epytext_demo.dem...>
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Maybe this Issue about --process-fields and --process-types is relevant? https://github.com/twisted/pydoctor/issues/568
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
I think this is what the term "intersphinx" is about or not? https://pydoctor.readthedocs.io/en/latest/sphinx-integration.html
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
Hi, On Sun, 8 May 2022 at 14:15, <c.buhtz@posteo.jp> wrote:
Whe whole documentation is generated via Read The Docs and Sphinx. There is an "extension" for Sphinx, to build pydoctor HTML files as part of the standard sphinx build process. The sphinx configuration is here. https://github.com/twisted/pydoctor/blob/master/docs/source/conf.py#L98 And Read The Docs configuration is here https://github.com/twisted/pydoctor/blob/master/readthedocs.yml Cheers
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Am 08.05.2022 16:03 schrieb Adi Roiban:
Whe whole documentation is generated via Read The Docs and Sphinx.
It is still unclear for my why you do that. Why didn't you use pydoctor to create the docs? If ReadTheDocs doesn't support that you should switch to another solution.
There is an "extension" for Sphinx, to build pydoctor HTML files as part of the standard sphinx build process.
This confused me much more. ;) I don't get it. But possibly I don't have to. :D
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
On Sun, 8 May 2022 at 15:34, <c.buhtz@posteo.jp> wrote:
Any PR for improving the current state of the project is welcomed :) This includes a PR to improving the way pydoctor own documentation is hosted and generated
There is some documentation here https://pydoctor.readthedocs.io/en/latest/sphinx-integration.html#building-p... If something is not clear any PRs to improve the docs is welcomed. Regards -- Adi Roiban
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
The big picture is still missing for me. I don't understand. What does Sphinx what pydoctor is not able to do? When I prepare my py-files to be processed by pydoctor why should I use sphinx then? Am 08.05.2022 17:00 schrieb Adi Roiban:
Any PR for improving the current state of the project is welcomed :)
Comments like this especially with a (sarcastic?) smiley are impolite to new users and possible contributors. I do what I can to help, to improve the project and to value your freetime/unpayed resources you invest in that great project. I still created two (very tiny unimportant) PR's. But I can't create a PR for something that I don't understand.
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
Hi, On Sun, 8 May 2022 at 16:43, <c.buhtz@posteo.jp> wrote:
The big picture is still missing for me. I don't understand. What does Sphinx what pydoctor is not able to do?
This is about integrating your narrative documentation with the API documentation. pydoctor focuses on API docs and not on generic documentation.
When I prepare my py-files to be processed by pydoctor why should I use sphinx then?
pydoctor can be used as a stand-alone tool. No need to use Sphinx if you don't want to.
Sorry about that. it wasn't meant to be sarcastic. My intention was to make it clear that I am not against switching to another solution. Cheers -- Adi Roiban
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Maybe this Issue about --process-fields and --process-types is relevant? https://github.com/twisted/pydoctor/issues/568
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
I think this is what the term "intersphinx" is about or not? https://pydoctor.readthedocs.io/en/latest/sphinx-integration.html
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
Hi, On Sun, 8 May 2022 at 14:15, <c.buhtz@posteo.jp> wrote:
Whe whole documentation is generated via Read The Docs and Sphinx. There is an "extension" for Sphinx, to build pydoctor HTML files as part of the standard sphinx build process. The sphinx configuration is here. https://github.com/twisted/pydoctor/blob/master/docs/source/conf.py#L98 And Read The Docs configuration is here https://github.com/twisted/pydoctor/blob/master/readthedocs.yml Cheers
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
Am 08.05.2022 16:03 schrieb Adi Roiban:
Whe whole documentation is generated via Read The Docs and Sphinx.
It is still unclear for my why you do that. Why didn't you use pydoctor to create the docs? If ReadTheDocs doesn't support that you should switch to another solution.
There is an "extension" for Sphinx, to build pydoctor HTML files as part of the standard sphinx build process.
This confused me much more. ;) I don't get it. But possibly I don't have to. :D
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
On Sun, 8 May 2022 at 15:34, <c.buhtz@posteo.jp> wrote:
Any PR for improving the current state of the project is welcomed :) This includes a PR to improving the way pydoctor own documentation is hosted and generated
There is some documentation here https://pydoctor.readthedocs.io/en/latest/sphinx-integration.html#building-p... If something is not clear any PRs to improve the docs is welcomed. Regards -- Adi Roiban
![](https://secure.gravatar.com/avatar/148a51ecc80531586e1f5530d64b988a.jpg?s=120&d=mm&r=g)
The big picture is still missing for me. I don't understand. What does Sphinx what pydoctor is not able to do? When I prepare my py-files to be processed by pydoctor why should I use sphinx then? Am 08.05.2022 17:00 schrieb Adi Roiban:
Any PR for improving the current state of the project is welcomed :)
Comments like this especially with a (sarcastic?) smiley are impolite to new users and possible contributors. I do what I can to help, to improve the project and to value your freetime/unpayed resources you invest in that great project. I still created two (very tiny unimportant) PR's. But I can't create a PR for something that I don't understand.
![](https://secure.gravatar.com/avatar/eba6eb871de2549c7447a8701352cd35.jpg?s=120&d=mm&r=g)
Hi, On Sun, 8 May 2022 at 16:43, <c.buhtz@posteo.jp> wrote:
The big picture is still missing for me. I don't understand. What does Sphinx what pydoctor is not able to do?
This is about integrating your narrative documentation with the API documentation. pydoctor focuses on API docs and not on generic documentation.
When I prepare my py-files to be processed by pydoctor why should I use sphinx then?
pydoctor can be used as a stand-alone tool. No need to use Sphinx if you don't want to.
Sorry about that. it wasn't meant to be sarcastic. My intention was to make it clear that I am not against switching to another solution. Cheers -- Adi Roiban
participants (2)
-
Adi Roiban
-
c.buhtz@posteo.jp