Created a docs version of the ReadMe file.

[Veronika271]

I used the content in the ReadMe file to make a new directory which has a Mkdocs website. I'm not quite sure how to continuously host this page instead of having it be open whenever you run makedocs serve, but this should create a working documentation website!

[yibeichan]

@Veronika271 thank you!! could you please

• remove the parent folder reproschema-py-tutorial so we use docs directly
• deploy the doc to github pages, see this link https://www.mkdocs.org/user-guide/deploying-your-docs/

[Veronika271]

Sorry for the delay! I just took everything out of the parent folder and pushed it, but when I try to run mkdocs gh-deploy from the main branch, it still creates a docs website at this link: https://veronika271.github.io/reproschema-py/. I'm not quite sure how to fix that.

[yibeichan]

change the site_name to reproschema-py

[Veronika271]

just fixed, thank you!

[yibeichan]

Hi @Veronika271 thank you!!
now let's deploy it via github action see the following link
https://github.com/marketplace/actions/deploy-mkdocs
so you will need to create an YAML file in this folder https://github.com/ReproNim/reproschema-py/tree/main/.github/workflows
you can name it as deploy-mkdocs.yml
if it requires a token, use GITHUB_TOKEN: ${{ secrets.AUTO_TOKEN }}

[yibeichan]

change to https://repronim.github.io/reproschema-py/