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

Fix broken link to Introduction in DjangoApp docs #705

Merged
merged 3 commits into from Oct 14, 2019
Merged

Conversation

a-recknagel
Copy link
Collaborator

@a-recknagel a-recknagel commented Oct 13, 2019

Might take care of #256

@a-recknagel a-recknagel requested a review from philippjfr Oct 13, 2019
doc/conf.py Show resolved Hide resolved
@philippjfr
Copy link
Member

@philippjfr philippjfr commented Oct 14, 2019

Thanks for the fixes!

@philippjfr philippjfr merged commit 11e1b37 into master Oct 14, 2019
2 of 3 checks passed
@a-recknagel a-recknagel deleted the ar/fix_docs_links branch Oct 14, 2019
@@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"As the core user guides including the [Introduction](Introduction.ipynb) have demonstrated, it is easy to display Panel apps in the notebook, launch them from an interactive Python prompt, and deploy them as a standalone Bokeh server app from the commandline. However, it is also often useful to embed a Panel app in large web application, such as a Django web server. Using Panel with Django requires a bit more work than for notebooks and Bokeh servers.\n",
"As the core user guides including the [Introduction](../getting_started/index.html) have demonstrated, it is easy to display Panel apps in the notebook, launch them from an interactive Python prompt, and deploy them as a standalone Bokeh server app from the commandline. However, it is also often useful to embed a Panel app in large web application, such as a Django web server. Using Panel with Django requires a bit more work than for notebooks and Bokeh servers.\n",
Copy link
Member

@jbednar jbednar Oct 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this have been ../getting_started/Introduction.ipynb?

Copy link
Member

@jbednar jbednar Oct 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(That way the link should work both in Jupyter and on the website. Otherwise, it will fail in Jupyter because the .html version is not present in a user's copy of the notebooks.)

Copy link
Collaborator Author

@a-recknagel a-recknagel Oct 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a good chance that the error in my docs build setup that I referred to here lead me to believe that I can only specify the index and not the notebook. I can push a fix, but I can't test it. It would be just exchanging the link for ../getting_started/Introduction.ipynb

Copy link
Collaborator Author

@a-recknagel a-recknagel Oct 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@philippjfr philippjfr Oct 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have reviewed with more care sorry.

Copy link
Member

@philippjfr philippjfr Oct 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I'm not entirely sure there is a consistent way to link this since Introduction.ipynb ends up being built as part of index.html.

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 this pull request may close these issues.

None yet

3 participants