[Doc/Dev] Off-by-one errors for line numbers in documentation source

[DanielYang59]

The source code line numbers generated from:

pymatgen/docs/apidoc/conf.py

Line 360 in edcd465

filename = f"pymatgen/core/{rel_path}#L{line_start}-L{line_end}"

Seems to have off-by-one errors for some classes, but not all.

For example in https://pymatgen.org/pymatgen.alchemy.html, pointer to AbstractStructureFilter is correct, but off-by-one for ChargeBalanceFilter

[DanielYang59]

I'm currently looking into this. I believe this linkcode_resolve is working correctly, and the issue should be related to the source code locating mechanism.

The final URL is reported on a specific version (the correct behaviour):

pymatgen/docs/apidoc/conf.py

Line 365 in 5404615

return f"https://github.com/materialsproject/pymatgen/blob/v{__version__}/src/{filename}"

However the source code locating is done on sys.modules, meaning it would depend on what version of pymatgen is installed on the person what called linkcode_resolve, and as developers tend to install pymatgen in editable mode, the page number in editable package and the published static version might be inconsistent.

pymatgen/docs/apidoc/conf.py

Line 345 in 5404615

obj = sys.modules[info["module"]]

I believe this would be resolved by #4056, i.e. automate the docs building process and install corresponding static version of pymatgen.