Skip to content

Broken link to github on ReadTheDocs #1789

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

Closed
JiaweiZhuang opened this issue Dec 18, 2017 · 8 comments
Closed

Broken link to github on ReadTheDocs #1789

JiaweiZhuang opened this issue Dec 18, 2017 · 8 comments

Comments

@JiaweiZhuang
Copy link

The "Edit on GitHub" button on ReadTheDocs is linked to
https://github.com/pydata/xarray/blob/origin/stable/doc/index.rst
which doesn't exist. The correct URL would be without "origin":
https://github.com/pydata/xarray/blob/stable/doc/index.rst

@shoyer
Copy link
Member

shoyer commented Dec 18, 2017

Thanks... I don't know if these links have ever worked properly for us. If anyone can figure out how to fix them, a PR would be appreciated!

@raybellwaves
Copy link
Contributor

I started to have a look at this.

I needed to install rasterio to build the docs but unfortunately the conda installation isn't working (see conda-forge/rasterio-feedstock#53) nor is the pip installation (see rasterio/rasterio#1244).

Anyone who uses a Mac and mostly installs via conda have any advice installing rasterio?

@fmaussion
Copy link
Member

I'm not sure it'll help, but have you tried creating the environment with the same pinned versions as we use for building the docs? i.e:

conda env create -n xarray-docs -f /path/to/xarray/doc/environment.yml

@shoyer
Copy link
Member

shoyer commented Jan 8, 2018

I have also had trouble getting a rasterio build working on OS X.

To be honest, I have been commenting out the bit in the docs config that sets up sphinx gallery when testing locally:

'sphinx_gallery.gen_gallery',

It would be nice if a lack of rasterio did not fail the docs build.

@shoyer
Copy link
Member

shoyer commented Jan 8, 2018

It looks like expected_failing_examples would take care of it:
https://sphinx-gallery.github.io/advanced_configuration.html#don-t-fail-the-build-on-exit

@Zac-HD
Copy link
Contributor

Zac-HD commented Feb 9, 2018

Related to readthedocs/readthedocs.org#1820, I think. Searching reveals that there have been a variety of problems with the 'Edit on Github' link over time.

@shoyer
Copy link
Member

shoyer commented Feb 9, 2018 via email

@dcherian
Copy link
Contributor

The link works now.

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

No branches or pull requests

6 participants