### download 3rd-party PHP libraries
composer_dependencies: clean
- composer update --no-dev
+ composer install --no-dev --prefer-dist
find vendor/ -name ".git" -type d -exec rm -rf {} +
### generate a release tarball and include 3rd-party dependencies
-release_tar: composer_dependencies
+release_tar: composer_dependencies doc_html
git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
+ tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/
gzip $(ARCHIVE_VERSION).tar
### generate a release zip and include 3rd-party dependencies
-release_zip: composer_dependencies
+release_zip: composer_dependencies doc_html
git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
- mkdir $(ARCHIVE_PREFIX)
+ mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor}
+ rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
+ zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)doc/
rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/
zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/
rm -rf $(ARCHIVE_PREFIX)
@rm -rf doxygen
@( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen -
-### update the local copy of the documentation
-doc: clean
- @rm -rf doc/md/
- @git clone https://github.com/shaarli/Shaarli.wiki.git doc/md
- mv doc/md/Home.md doc/md/index.md
- @rm -rf doc/md/.git
-
### Convert local markdown documentation to HTML
#
# For all pages:
# - convert GitHub-flavoured relative links to standard Markdown
# - generate html documentation with mkdocs
htmlpages:
- # Rename local [[links]] to regular links.
- @for file in `find doc/md/ -maxdepth 1 -name "*.md"`; do \
- sed -e "s/\[\[\(.*\)\]\]/[\1](\1)/g" "$$file" > doc/md/tmp.md; \
- mv doc/md/tmp.md $$file; \
- done
-
python3 -m venv venv/
bash -c 'source venv/bin/activate; \
pip install mkdocs; \
find doc/html/ -type f -exec chmod a-x '{}' \;
rm -r venv
-doc_html: authors doc htmlpages
+doc_html: authors htmlpages