Poliastro: `py:mod` roles do not link to corresponding summary page

Created on 3 May 2021  路  6Comments  路  Source: poliastro/poliastro

And they have never worked, apparently. See for example https://docs.poliastro.space/en/v0.13.1/changelog.html#backwards-incompatible-changes

I wonder if this is a limitation of autodoc or if we're misusing it.

bug documentation

Most helpful comment

Hahaha oh dear, I didn't know this! Thanks for actually _reading the docs_... I think it's safe to close this issue then.

All 6 comments

Hello @astrojuanlu, I did some digging around ... Though I haven't found any example where I can see the actual working of this py:mod tag, I have made some changes as shown
image
I don't understand this but this looks better :) ... It doesn't link to the summary page though 馃槬

It doesn't link to the summary page though 馃槬

Then it's not what we want... If py:class and py:meth work, I would be very interested in knowing why py:mod doesn't.

It would be very interested in knowing why py:mod doesn't

I may have understood why it is not working ... It is not working because the current file is not present in the updated codebase ... what I mean by this is that when we are referencing the module with the py:mod directive, due to the newer codebase not having the file, it is not linking it ... similar case would be when we link to a function or a class which doesn't exist in the codebase 馃 ... Also because of this we are not able to link to the module page in the newer revision of the docs via the codebase

You're right that the example I linked is a bad one. But I tried with other modules that do exist, with identical result.

@astrojuanlu I found the answer, we were looking for ... it is on their docs page 馃う馃徏
image
We can do nothing in this context ... I think this closes this issue as well 馃槥 {Link here as well, check the last line of the paragraph}

Hahaha oh dear, I didn't know this! Thanks for actually _reading the docs_... I think it's safe to close this issue then.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

astrojuanlu picture astrojuanlu  路  6Comments

astrojuanlu picture astrojuanlu  路  4Comments

void4 picture void4  路  6Comments

DhruvSondhi picture DhruvSondhi  路  3Comments

cpbridges picture cpbridges  路  7Comments