Skip to content

Commit

Permalink
Add Doxygen generation
Browse files Browse the repository at this point in the history
  • Loading branch information
thucke committed Oct 28, 2019
1 parent a34eae2 commit 0f84b55
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Build/Scripts/runTravisDoxygen.sh
@@ -1,6 +1,21 @@
#!/usr/bin/env bash

# ---------------------------------------------------------------------------------------------
# Preparation for publishing to github pages
# ---------------------------------------------------------------------------------------------
# 1. Create a local brach gh-pages
# git checkout --orphan gh-pages
# 2. You may remove all the stuff in this branch and add your html
# # preview files to be deleted
# $ git rm -rf --dry-run .
# # actually delete the files
# $ git rm -rf .
# 3. Push the new branch to Github
# git push -u origin gh-pages

# ---------------------------------------------------------------------------------------------
# see https://benlimmer.com/2013/12/26/automatically-publish-javadoc-to-gh-pages-with-travis-ci/
# ---------------------------------------------------------------------------------------------
# [ "$TRAVIS_REPO_SLUG" == "thucke/TYPO3.ext.th_rating" ]
# We want this to only happen from our repo, not forks.
# Since people will clone this script when they fork the repo, we don’t want them to be able to publish doc
Expand Down
2 changes: 2 additions & 0 deletions Documentation/ResourcesForEditors.rst
Expand Up @@ -9,3 +9,5 @@ Resources for This Guide
(list of warnings)
* `Issues on Github <https://github.com/thucke/TYPO3.ext.th_rating/issues>`__
(or click on "Related links", "Issues")
* `Doxygen generated on Github<http://thucke.github.io/TYPO3.ext.th_rating/>`__

0 comments on commit 0f84b55

Please sign in to comment.