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

Add to documentation the use of raw cells when discussing links to *.rst files with domain objects (example_python_function) #624

Closed
1kastner opened this issue Jan 5, 2022 · 3 comments · Fixed by #631

Comments

@1kastner
Copy link
Contributor

1kastner commented Jan 5, 2022

Hello there and thanks a lot for this great project! This was exactly what I was searching for. I love the feature that the Jupyter Notebook can be tried out, it is a well-supported technology and I can embed it into my documentation.

First, I struggled a bit about how to include the references to the remaining Sphinx documentation because in https://nbsphinx.readthedocs.io/en/0.8.8/markdown-cells.html#Links-to-*.rst-Files-(and-Other-Sphinx-Source-Files), an approach is used that I found a bit counter-intuitive. But after a bit of searching I found the Raw Cells that allow me to create links the Sphinx way! So I was wondering whether the documentation could be clearer at this point? I would love to see there that two approaches exist. Either one can create the links manually (as nicely discussed at https://nbsphinx.readthedocs.io/en/0.8.8/a-normal-rst-file.html#links-to-notebooks-and-other-sphinx-source-files) or one can decide to live with less beautiful Jupyter Notebooks that contain ReST code but which smoothly integrates with the Sphinx documentation. The second one could maybe be another section in the same document?

@1kastner 1kastner changed the title Add mention of raw cells when discussing links to *.rst files with domain objects (example_python_function) Add to documentation the use of raw cells when discussing links to *.rst files with domain objects (example_python_function) Jan 5, 2022
@mgeier
Copy link
Member

mgeier commented Jan 9, 2022

Yes, that's a good idea, would you like to make a PR for this?

@1kastner
Copy link
Contributor Author

1kastner commented Jan 9, 2022

Sure, I will create a draft soon.

@1kastner
Copy link
Contributor Author

That was my first light-weight idea. It only adds a few lines that hopefully help future readers.

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