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

Example notebooks need to be become visible on our RTD page #409

Closed
4 tasks done
fsenf opened this issue Feb 21, 2024 · 1 comment
Closed
4 tasks done

Example notebooks need to be become visible on our RTD page #409

fsenf opened this issue Feb 21, 2024 · 1 comment
Labels
bug Code that is failing or producing the wrong result

Comments

@fsenf
Copy link
Member

fsenf commented Feb 21, 2024

  • Have you searched the issue tracker for the same problem?
  • Have you checked if you're using the latest version? If not, which version are you using?
  • Have you mentioned the steps to reproduce the issue?
  • Have you, if applicable, included error messages?

After #334 is done, index.rst needs to be modified such that examples are rendered on readthedocs (RTD) and therefore become visible.

Typically, sphinx rendering only sees things below its root dir which is ./doc in our case. Maybe one solution could be include a symbolic link there

i.e.

cd doc
ln -s ../examples .

# and then git it
@fsenf fsenf added the bug Code that is failing or producing the wrong result label Feb 21, 2024
@fsenf fsenf mentioned this issue Feb 28, 2024
11 tasks
@w-k-jones
Copy link
Member

Closed with #411

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Code that is failing or producing the wrong result
Projects
None yet
Development

No branches or pull requests

2 participants