https://github.com/balletie/doc_scripts

Scripts for building and deploying docs in Pillar format to GitHub pages.
https://github.com/balletie/doc_scripts

Last synced: 20 days ago
JSON representation

Scripts for building and deploying docs in Pillar format to GitHub pages.

• Host: GitHub
• URL: https://github.com/balletie/doc_scripts
• Owner: Balletie
• Created: 2016-01-20T11:14:19.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-28T21:10:17.000Z (almost 9 years ago)
• Last Synced: 2023-05-16T22:01:05.528Z (over 1 year ago)
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

        
doc_scripts

Scripts for building and deploying docs in Pillar format

to GitHub pages. This is meant to be used as submodule

within a repository including a 'doclink_config.ini' file.

Files:

- doclink.py: Creates links to source code within Pillar

  files. See './doclink.py --help' for usage and info.

- build.sh: Build the Pillar build product with links

  linked to source code in the `master` branch of the

  parent repository. Reads from '../doclink_config.ini'

  the options for './doclink.py'.

- deploy.sh: Uses build.sh and deploys to the `gh-pages`

  of the parent repository.-

- example.ini: example template config file for

  '../doclink_config.ini' in the parent repository.

- install_git.sh: Used to install a Git version with

  the git-worktree builtin. Originally meant for use

  with Travis CI, which has an old version of Git.