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

Host documentation #4

Open
ben-albrecht opened this issue Nov 9, 2017 · 6 comments
Open

Host documentation #4

ben-albrecht opened this issue Nov 9, 2017 · 6 comments

Comments

@ben-albrecht
Copy link
Collaborator

Host chpldoc-generated documentation, possibly utilizing https://pages.github.com/ in a docs/ directory.

Ideally, CI (Travis?) could build and update this documentation for every PR.

@ben-albrecht
Copy link
Collaborator Author

If using github pages, don't forget to add a .nojekyll file.

@marcoscleison
Copy link
Collaborator

Thank you Ben. I will organize the doc because my personal website is hosted in github pages. I will make it as subfolder project.
I will notify you when things go on.

@marcoscleison
Copy link
Collaborator

@ben-albrecht, I did not forget this issue. I am getting an error in the RST compiling. This is occurring because I forgot some comma in the comments.
When I port the ORM to MySQL and SQLite I will document it and close this issue.

@krishnadey30
Copy link
Collaborator

I have hosted the documentation https://krishnadey30.github.io/cdo-docs/
@buddha314 @ben-albrecht

@ben-albrecht
Copy link
Collaborator Author

Looks great @krishnadey30 - How about I create a gh-pages branch on cdo repo and you can push the built docs to there?

@ben-albrecht
Copy link
Collaborator Author

I have pushed your docs to marcoscleison/cdo/gh-pages, but unfortunately I do not have admin permissions for the repo to flip the switch and enable github pages. @marcoscleison - would you be able to do that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants