panel In the website docs, include a link on every doc page to the Github .md source for that document

Being able to go straight to the Github .md if an improvement or type is noticed in a doc would make the process more seamless. As it is now, a doc source needs to be located manually in Github.

Mar 14 '24 16:03 Coderambling

hi @philippjfr ,

I am willing to work on this issue. Which branch is used for the docs and any additional things I should know about ?

Mar 23 '24 05:03 HarshaDokula

Hi @HarshaDokula . That would be great! Quoting @MarcSkovMadsen "One challenge is that the reference guides are created from notebooks that are rendered during build and copied into the docs folder. But that challenge can probably be solved."

I think Sphinx is used for the build process, but I don't know further details.

Example of a webpage and associated Github notebook location:

Website page:

https://panel.holoviz.org/reference/panes/Alert.html

Notebook location on Github:

https://github.com/holoviz/panel/blob/main/examples/reference/panes/Alert.ipynb

So I guess if every Notebook would contain a (Github icon) with a hyperlink to its Github location, that would solve it. So how to add that (programmatically) in each Notebook?

The top of each page already contains an Open in Jupterlyte link, and download this Notebook link, but that one goes to the raw version: https://raw.githubusercontent.com/holoviz/panel/main/examples/reference/panes/Alert.ipynb

I don't know if those links are manually created.

But maybe the Notebook could include a var like (pseudocde)

Raw_url = var containing raw.githubuser... from the download link.

Github_url = replace the Raw _URL substring "https://raw.githubusercontent.com/" with "https://github.com/holoviz/panel/blob/main/examples/"

And then use that Github_url with icon / hyperlink text that says: Acces / fork in Github.

Mar 24 '24 23:03 Coderambling

@HarshaDokula That would be fabulous! The majority of the documentation lives in /doc. The exception are the component reference docs which live as notebooks in /examples/reference.

Mar 24 '24 23:03 philippjfr

@Coderambling, Thank you for the information.

Sphinx is used but it looks like some custom modification are done using nbsite package.
for adding "edit on GitHub" , there seems to be an extension that can be used: git gist on "edit on GitHub" extension for sphinx

@philippjfr , I have understood where the documentations are available.

while trying to generate the .md files for doc, sphinx generally uses makefile for generating the related webpages, I don't find any here. Is there any custom code you are using.
I have seen "scripts/gallery/convert_gallery.py" , if this is the script for generating webpages(".md files"), I might be missing something.
for some reason I am not able to setup panel. Getting error while setting up. can you take take look at the error please?

installation_error.txt

Thank you.

Mar 25 '24 07:03 HarshaDokula

Hi @HarshaDokula. Great find that extension! Hope it works in this context. No idea about the installation error :-)

Mar 25 '24 07:03 Coderambling

Hi @HarshaDokula . Great find that extension! Hope it works in this context.

No idea about the installation error :-) What environment are you setting up in?

Mar 25 '24 07:03 Coderambling

Hi @Coderambling , I have setup on a different environment now, It is working. Still have no idea what happened in the previous environment. Working on the issue now.

Mar 26 '24 21:03 HarshaDokula

What environment are you using currently?

Mar 27 '24 05:03 Coderambling

dev_details_previous.txt devENV_details_current.txt

Mar 27 '24 18:03 HarshaDokula

Hey @HarshaDokula , are you aware of the Panel Discord channel? https://discord.com/invite/Hh8WPK63

Mar 29 '24 02:03 Coderambling

@Coderambling , yes. Username : harshadokula

Mar 29 '24 03:03 HarshaDokula