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
Setup MKDocs for Documentation #294
Setup MKDocs for Documentation #294
Conversation
Codecov Report
@@ Coverage Diff @@
## master #294 +/- ##
=======================================
Coverage 90.05% 90.05%
=======================================
Files 54 54
Lines 2273 2273
=======================================
Hits 2047 2047
Misses 226 226
Continue to review full report at Codecov.
|
- Reference: | ||
Models: reference/models.md | ||
|
||
site_url: https://materials-consortia.github.io/optimade-python-tools/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the right URL? materials-consortia.github.io
redirects to optimade.org
, so I guess this should either go to optimade.org/optimade-python-tools
(if we get someone to update the domain settings for us) or to optimade-python-tools.github.io
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, good point. I don't know what happens to project repo pages when the org page is redirected...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any way we can test it before merging? Guess we need to enable Pages for this repo for one (will leave that to you when you're ready)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
http://materials-consortia.github.io/optimade-python-tools
goes to a 404 under github pages so I think should work. I can't test the deploy until this is merged in as mkdocs gh-deploy
uses the current remote
to find the gh-pages
branch. That being said, the docs will still work. Just the link back to the docs won't initially.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @shyamd, lets see if this works :)
This is a simple barebones setup of mkdocs:
mkdocstrings