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

Testing surge deployment from Travis #156

Open
wants to merge 1 commit into
base: master
from

Conversation

@vsoch
Copy link

commented Nov 29, 2018

This is a test deployment for documentation (doc strings, not user doc) to travis using surge. This is only ideal over pushing back to Github pages because putting a Github pages (encrypted) token in a CI is more risky than surge, which is connected to fewer important things :) Surge in my mind is akin to read the docs, but doesn't require sphinx (python) or mkdocs.

If this seems to work okay, then we can customize the style to better match the main docs. I actually like the "old school" style that this ocean template has, so I think all we would need to do is some minor adjustment of the color scheme, and then we can link to this from penrose.github.io. If it even works at all!

To summarize the steps I took here:

  • added a command to travis script to generate the docs
  • fixed a bug with the docstring that prevented it from rendering (at least in my Docker container)
  • added an (I hope) encrypted token to the travis environment to deploy
  • added a deploy section in the .travis.yml
…ed docs from rendering
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.