Skip to content

Created a docs version of the ReadMe file. #98

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Veronika271
Copy link
Collaborator

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
Copy link
Contributor

@Veronika271 thank you!! could you please

@Veronika271
Copy link
Collaborator Author

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.

mkdocs.yml Outdated
@@ -0,0 +1,11 @@
site_name: My Docs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change the site_name to reproschema-py

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just fixed, thank you!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants