Chaste / PyChaste

A Python Wrapper for Chaste
https://chaste.github.io/pychaste/
Other
2 stars 0 forks source link

Move PyChaste website #34

Open kwabenantim opened 1 year ago

kwabenantim commented 1 year ago

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

Related PRs

To Do

kwabenantim commented 1 year ago

Previous deployment failed, possibly due to permissions issues.

kwabenantim commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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:

kwabenantim commented 1 year ago

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

kwabenantim commented 12 months ago

Generating markdown for the website is fixed in this PR: https://github.com/Chaste/PyChaste/pull/50

kwabenantim commented 12 months ago

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 commented 5 months ago

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