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

[DOC] /user_guides/Panes.html is missing #628

Closed
rs2 opened this issue Aug 30, 2019 · 6 comments · Fixed by #708
Closed

[DOC] /user_guides/Panes.html is missing #628

rs2 opened this issue Aug 30, 2019 · 6 comments · Fixed by #708
Assignees
Labels
sprintable type: docs Related to the Panel documentation and examples

Comments

@rs2
Copy link
Contributor

rs2 commented Aug 30, 2019

ALL software version info:

Whatever was used to generate https://panel.pyviz.org/.

Description of expected behavior and the observed behavior

No hyperlinks in https://github.com/pyviz/panel/blob/master/examples/user_guide/Param.ipynb yield a 404.

Complete, minimal, self-contained example code that reproduces the issue

https://panel.pyviz.org/user_guide/Panes.html is not available, and I could not find suitable candidates in https://github.com/pyviz/panel/tree/master/examples/user_guide. See https://github.com/pyviz/panel/pull/466/files#diff-ce01fb962ef569b34c1649450526e27cR238. for the diff that introduced it.

@rs2 rs2 added the TRIAGE Default label for untriaged issues label Aug 30, 2019
@jbednar
Copy link
Member

jbednar commented Aug 31, 2019

I found a copy of Panes.ipynb on my hard drive, but I think it was just a sketch that wasn't really part of the proper documentation. It's hard to remember now, but it looks like we decided not to have an overview of panes other than in Components.ipynb, and instead just exhaustively list all of them in the Reference Gallery. So we should probably just change this link to point to the Panes section of Components.ipynb, or to the Panes section of the Reference Gallery.

@philippjfr philippjfr added sprintable type: docs Related to the Panel documentation and examples and removed TRIAGE Default label for untriaged issues labels Oct 13, 2019
@a-recknagel
Copy link
Contributor

a-recknagel commented Oct 13, 2019

I can't find references to a Panes.html anywhere in the project (ran grep -rnw -e 'Panes.html' in the root after building docs), can you @rs2 give a better description on where this link would be found, full url to the containing page and a screenshot of the rendered link?

@a-recknagel a-recknagel self-assigned this Oct 13, 2019
@rs2
Copy link
Contributor Author

rs2 commented Oct 13, 2019

@a-recknagel
Copy link
Contributor

Thanks, found it. In lieu of an option to link to sections of .ipynb files I'll just link to Components instead. Better than 404.

@jbednar
Copy link
Member

jbednar commented Oct 13, 2019

You can link to sections of .ipynb files; just do "file.ipynb#Section-name", for a section named "Section name".

@a-recknagel
Copy link
Contributor

a-recknagel commented Oct 14, 2019

I can't fully test it localy, when I build the docs the .ipynb part of the urls don't get turned into .html, but obviously that's what happens in the actual deployment. So I guess I can start the PR. In case anyone knows, do I need to do something else besides this?

$ nbsite generate-rst --org pyviz --project-name panel
$ sphinx-build doc public -b html -a

pip freeze

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sprintable type: docs Related to the Panel documentation and examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants