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

Switch to Sphinx for building website #2

Closed
redeboer opened this issue Apr 11, 2024 · 4 comments · Fixed by #5
Closed

Switch to Sphinx for building website #2

redeboer opened this issue Apr 11, 2024 · 4 comments · Fixed by #5
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@redeboer
Copy link
Collaborator

redeboer commented Apr 11, 2024

Solution: #2 (comment)


For some reason, the cells on the HTML output are not shown with output.
https://shenvitor.github.io/sympy-playground/

Probably you have to set some settings in the myst.yml, but not sure what. Have a look at https://mystmd.org/guide/integrating-jupyter, for instance.

@redeboer
Copy link
Collaborator Author

Looks like you need to add the --execute flag here:

run: myst build --html

@shenvitor shenvitor self-assigned this Apr 12, 2024
@shenvitor
Copy link
Owner

shenvitor commented Apr 16, 2024

The problem is even after adding the tag "raises-exception" in Jupyter notebook.
The MyST MD does not recognize it and stopped and cause error.
They mentioned they fixed: jupyter-book/mystmd#873
But seems like it still doesn't work in our case

See error: https://github.com/shenvitor/sympy-playground/actions/runs/8707079086/job/23881241237#step:6:28

@redeboer
Copy link
Collaborator Author

Yeah I would switch back to Sphinx and related MyST packages, in particular https://myst-nb.rtfd.io. Jupyter Book is also an option: easier to use, but a bit slower release cycle.

The challenge with using higher-level Sphinx extensions like MyST-NB, is that you have to configure through a conf.py file. Have a look at AmpForm's configuration, for instance. Or to become more familiar with conf.py files, write your own by generating a first template with sphinx-quickstart.

@redeboer
Copy link
Collaborator Author

Of course, pixi remove mystmd etc and pixi add the relevant Sphinx packages/extensions.

@shenvitor shenvitor added bug Something isn't working documentation Improvements or additions to documentation labels Apr 29, 2024
@redeboer redeboer changed the title Cell output is missing on the website Switch to Sphinx for building website Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants