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

Automatically build documenation and deploy to gh-pages branch #12

Merged
merged 3 commits into from
Jan 20, 2021

Conversation

stephendolan
Copy link
Collaborator

@stephendolan stephendolan commented Jan 20, 2021

This PR tackles the following:

  • Remove the committed documentation
  • Add /docs/ to .gitignore
  • Add documentation link in the README

This will close #8

@confact, all you'll need to do once we merge this is wait for the GitHub action to finish, then point the GitHub docs in the repo settings to the gh-pages branch! You don't have to set the directory to serve from to docs or anything. Here's a screenshot from Pundit:
Screen Shot 2021-01-20 at 3 51 36 PM

@confact
Copy link
Owner

confact commented Jan 20, 2021

@stephendolan looks great! LGTM

@stephendolan stephendolan merged commit 0503f78 into master Jan 20, 2021
@stephendolan stephendolan deleted the sd-documentation-builder branch January 20, 2021 20:54
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.

Automatically generate and host API documentation
2 participants