Review docs for links, etc.

[jGaboardi]

Following #336 & #337, a review of the docs are needed for stale/broken links. Examples include:

• libpysal.weights.weights.W in spaghetti.Network.extract_components

Specifically check for links to other packages link geopandas. Be sure to check check the generated locally for format and link functionality.

[rahul799]

@jGaboardi I would like to work on this. I am new to PySal, and not sure if it is necessary to be assigned the issue to work on it? Can you assign this to me?

[jGaboardi]

@rahul799 Thanks for reaching out! It is not necessary to be assigned and contributions are welcome! If you haven't reviewed to our Community Guidelines, Contributing Guidelines, and Getting Started w/PySAL, please do so and let me know if you have any questions.

[jGaboardi]

• ensure external package/class/function references are in the proper format for intersphinx_mapping

[rahul799]

@jGaboardi Thanks for the response. I have read all the Guidelines & am ready to contribute. I just wanted to know what exactly I need to do with the broken links. As in, do I need to remove them or commenting them out will be fine?

[jGaboardi]

just wanted to know what exactly I need to do with the broken links. As in, do I need to remove them or commenting them out will be fine?

@rahul799 I would like to incorporate intersphinx mapping into the spaghetti docs (see comment above). This is something that I have never tried (it is completely new to me), and was brought up in the libpysal repo by @knaaptime (original PR here). Also, see the pysal/submodule_template#23 PR by @weikang9009.

[knaaptime]

I think the reference to libpysal.weights.weights.W should actually be libpysal.weights.W (which would properly point here as long as intersphinx is set to point at https://pysal.org/libpysal/ instead of http://readthedocs.libpysal.io/ where the docs are no longer being published

[knaaptime]

As in, do I need to remove them or commenting them out will be fine?

neither, actually. They need to be edited to ensure that they properly reference the function or class they point to. Typically, that just means using the full module path to the function. So if you wanted to reference Pysal's open function, you would use libpysal.io.open

[jGaboardi]

@rahul799, @knaaptime provides an excellent example of what we want to do here: have sphinx be able to automatically generate links to other published doc sites. In order for this to happen, all references to external objects must be in the correct format and the package must be contained within the intersphinx_mapping variable found in docsrc/conf.py .

[rahul799]

@jGaboardi , @knaaptime I have understood the task. Will work accordingly. Thanks for the help.

[jGaboardi]

#339

[rahul799]

@jGaboardi , @knaaptime .Please have a look at this PR. I have never worked with sphinx & I am new to open source community & this is my first contribution so let me know if any changes I need to make.

[jGaboardi]

This is being address in #342