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

Move PyChaste website #34

Open
4 of 6 tasks
kwabenantim opened this issue Aug 2, 2023 · 8 comments · Fixed by #50, #58 or #59 · May be fixed by #65
Open
4 of 6 tasks

Move PyChaste website #34

kwabenantim opened this issue Aug 2, 2023 · 8 comments · Fixed by #50, #58 or #59 · May be fixed by #65
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kwabenantim
Copy link
Member

kwabenantim commented Aug 2, 2023

Description
Move the PyChaste website to the Chaste organisation under chaste.github.io

Related PRs

To Do

@kwabenantim kwabenantim added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 2, 2023
@kwabenantim kwabenantim self-assigned this Aug 2, 2023
@kwabenantim kwabenantim added this to the BBR milestone 3.1 milestone Sep 19, 2023
@kwabenantim
Copy link
Member Author

Previous deployment failed, possibly due to permissions issues.

@kwabenantim
Copy link
Member Author

The old Jekyll site is now deployed to https://chaste.github.io/PyChaste.
It probably needs redoing to match the modern Hugo theme on https://chaste.github.io.

@kwabenantim
Copy link
Member Author

It probably needs redoing to match the modern Hugo theme on https://chaste.github.io.

As part of #46, content from the PyChaste website will be moved into chaste.github.io

@kwabenantim kwabenantim linked a pull request Oct 12, 2023 that will close this issue
@kwabenantim
Copy link
Member Author

kwabenantim commented Nov 7, 2023

The PyChaste website is being re-created in markdown directly under chaste.github.io (see PR https://github.com/Chaste/Chaste.github.io/pull/17).

Things to consider for python notebook tutorials:

  • Generate markdown from ipynb automatically to keep them in sync.
  • Create cron job to periodically check current ipynb against markdown and update markdown manually.

@kwabenantim
Copy link
Member Author

nbconvert can help with the automatic conversion of Jupyter notebooks to markdown.

@kwabenantim
Copy link
Member Author

Generating markdown for the website is fixed in this PR: #50

@kwabenantim
Copy link
Member Author

kwabenantim commented Nov 29, 2023

Python is not specified in the code blocks for some of the generated tutorial markdown, which affects syntax highlighting on the website.

Bad Example

import os
def main:
    print("Code block without 'python'")

https://chaste.github.io/pychaste/tutorials/pottsbasedcellsimulations/

Good Example

import os
def main:
    print("Code block with 'python'")

https://chaste.github.io/pychaste/tutorials/cellsorting/

Resolution
The bad examples are duplicate tutorials that were not overwritten with autogenerated ones. They will be removed.

@kwabenantim
Copy link
Member Author

As part of #46, PyChaste API generation will be moved to Chaste infra.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment