Created
August 18, 2013 07:48
-
-
Save f440/6260460 to your computer and use it in GitHub Desktop.
Sphinx utilities
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Sphinx Utilities | |
| ================ | |
| # Setup | |
| pip install -r requirements.txt | |
| bundle install | |
| # Usage | |
| foreman start |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| source 'https://rubygems.org' | |
| gem 'guard-livereload' | |
| gem 'guard-shell' | |
| gem 'rb-fsevent' | |
| gem 'foreman' | |
| gem 'terminal-notifier-guard' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| guard 'shell' do | |
| watch(%r{(.*)\.rst}) do |m| | |
| system("sphinx-build -b html -d build/doctrees source build/html") | |
| end | |
| end | |
| guard 'livereload' do | |
| watch(%r{(.*)\.rst}) | |
| end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| web: ruby -run -e httpd -- --port=3000 build/html | |
| gaurd: bundle exec guard |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| sphinx |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment