Skip to content

Commit 17091cd

Browse files
committed
README: Clarify documentation referencing slicer-apidocs-builder and github-circleci-trigger
1 parent 67a56d4 commit 17091cd

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,20 @@ This project hosts the Slicer API documentation served from http://apidocs.slice
77

88
Documentation is automatically generated and pushed to the `gh-pages` branch configured as a [GitHub Pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/) source.
99

10-
For more details, see https://github.com/Slicer/slicer-apidocs-builder
11-
12-
13-
## Squash of `gh-pages` branch using TravisCI Cron Job
10+
The [slicer-apidocs-builder](https://github.com/Slicer/slicer-apidocs-builder) tool is used within a CircleCI
11+
build to checkout Slicer source code, build doxygen documentation and publish generated html pages.
1412

1513
Each time the `master` branch of https://github.com/Slicer/Slicer is updated or each time a new release tag
1614
is pushed, the generated documentation is either added to the `master` folder or added to a new folder
1715
named after the release tag. Then the updated content is pushed to the `gh-pages` branch.
1816

19-
After some time, the amount of data exceeds GitHub [recommended size of 1GB][max_size].
17+
The simple GitHub post-receive web hook handler triggering a CircleCI build is
18+
[github-circleci-trigger](https://github.com/Slicer/github-circleci-trigger). It is implemented as
19+
a Flask application hosted on a free heroku instance.
20+
21+
## Squash of `gh-pages` branch using TravisCI Cron Job
22+
23+
After some time, the amount of data published on the `gh-pages` exceeds GitHub [recommended size of 1GB][max_size].
2024
To cleanup the repository, a [TravisCI Cron Job][cronjob] associated with this project
2125
will be triggered weekly and will execute [gh-pages-squash.sh](./gh-pages-squash.sh) script.
2226

0 commit comments

Comments
 (0)