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

Setup MKDocs for Documentation #294

Merged
merged 6 commits into from Jun 8, 2020
Merged

Setup MKDocs for Documentation #294

merged 6 commits into from Jun 8, 2020

Conversation

shyamd
Copy link
Contributor

@shyamd shyamd commented Jun 8, 2020

This is a simple barebones setup of mkdocs:

  • Very simple index that is a copy of the readme
  • Simple API reference docs using mkdocstrings
  • Autogenerated changelog using PR names

@codecov
Copy link

codecov bot commented Jun 8, 2020

Codecov Report

Merging #294 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #294   +/-   ##
=======================================
  Coverage   90.05%   90.05%           
=======================================
  Files          54       54           
  Lines        2273     2273           
=======================================
  Hits         2047     2047           
  Misses        226      226           
Flag Coverage Δ
#unittests 90.05% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 17c3fe9...ead2465. Read the comment docs.

@shyamd shyamd requested review from CasperWA, ml-evs and fekad June 8, 2020 20:34
docs/index.md Outdated Show resolved Hide resolved
- Reference:
Models: reference/models.md

site_url: https://materials-consortia.github.io/optimade-python-tools/
Copy link
Member

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?

Copy link
Contributor Author

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...

Copy link
Member

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)

Copy link
Contributor Author

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.

requirements-docs.txt Outdated Show resolved Hide resolved
Copy link
Member

@ml-evs ml-evs left a 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 :)

@ml-evs ml-evs merged commit 8651cd5 into Materials-Consortia:master Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants