statsmodels / statsmodels.github.io

documentation for statsmodels - currently temporary structure and location
BSD 3-Clause "New" or "Revised" License
12 stars 9 forks source link

'Can't find anchor ... in ...' error when compiling docs with doc2dash #26

Open capac opened 1 year ago

capac commented 1 year ago

When I build the statsmodels docs for Dash, I usually get these types of errors, the 'Can't find anchor ... in ...'. Below are some such examples. Even so, the docs are created, however what I've noticed is that some index entries are repeated, such as the entries for sections (see image below).

Is this a statsmodels issue, or can it be confronted in doc2dash ?

Can't find anchor 'statsmodels.genmod.families.links.CLogLog' (EntryType.CLASS) in 'generated/statsmodels.genmod.families.links.CLogLog.html'.

Can't find anchor 'statsmodels.genmod.families.links.Log' (EntryType.SECTION) in 'generated/statsmodels.genmod.families.links.Log.html'.

Can't find anchor 'statsmodels.genmod.families.links.CLogLog.deriv' (EntryType.METHOD) in 'generated/statsmodels.genmod.families.links.CLogLog.deriv.html'.

repeated-entries-in-sections
bashtage commented 1 year ago

I don't know what doc2dash is, bit these are problems because there are both upper and lower case versions of the same links. This means that case insensitive file systems can't render docs correctly.

capac commented 1 year ago

Indeed, my file system is case-insensitive. Is there a way in statsmodels to retain just one link if multiple case sensitive links are available? As for doc2dash (https://doc2dash.readthedocs.io/en/stable/), I don't know its parser well enough to figure this issue out. I'll ask on the corresponding GitHub issues page.

bashtage commented 1 year ago

Can you build on Linux+case sensitive or WSL? This might be a solution. For 0.14.0 I think the lowercase links are deprecated and should not appear in the docs.