Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable intersphinx links #132

Closed
keewis opened this issue Nov 18, 2019 · 1 comment · Fixed by #133
Closed

Enable intersphinx links #132

keewis opened this issue Nov 18, 2019 · 1 comment · Fixed by #133

Comments

@keewis
Copy link
Contributor

keewis commented Nov 18, 2019

At the moment, the documentation of cftime provides a intersphinx file (https://unidata.github.io/cftime/objects.inv), but it does not contain entries for cftime.datetime and other attributes of the module:

$ python -m sphinx.ext.intersphinx https://unidata.github.io/cftime/objects.inv
std:doc
	api                                      API                                     : api.html
	index                                    cftime                                  : index.html
	installing                               Installation                            : installing.html
std:label
	genindex                                 Index                                   : genindex.html
	modindex                                 Module Index                            : py-modindex.html
	search                                   Search Page                             : search.html

This causes broken links and sphinx warnings in projects that try to link to it (e.g. xarray).

The easiest way I know to fix this would be to remove :noindex: from docs/api.rst.

@jswhit
Copy link
Collaborator

jswhit commented Nov 19, 2019

Pull request would be very much appreciated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants