Skip to content

Commit

Permalink
add docs publish script
Browse files Browse the repository at this point in the history
  • Loading branch information
sirfoga committed Oct 22, 2017
1 parent f0c22c4 commit f4460e2
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
### project specifics ###
.coveralls.yml
.idea/

### PyCharm ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
Expand Down
8 changes: 0 additions & 8 deletions .idea/modules.xml

This file was deleted.

33 changes: 33 additions & 0 deletions docs/make.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#!/usr/bin/env bash
# coding: utf_8

# Copyright 2016 Stefano Fogarollo
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


OUTPUT_FOLDER="epydoc/html/"
BUILD_FOLDER="build/"
COMMIT_MSG=$(git log -1 --pretty=%B) # last commit message

rm -rf ${OUTPUT_FOLDER} # clean
rm -rf ${BUILD_FOLDER}
mkdir ${BUILD_FOLDER} # prepare build folder

epydoc --config epydoc/Epydoc_html # make docs
mv ${OUTPUT_FOLDER}* ${BUILD_FOLDER} # move to build folder

git checkout gh-pages # change branch (to publish docs)
mv ${BUILD_FOLDER} ../ # publish docs at root folder
git add --all
git commit -m "${COMMIT_MSG} | generated docs"
File renamed without changes.

0 comments on commit f4460e2

Please sign in to comment.