Documentation+Makefile: update AUTHORS generation
Fixes https://github.com/shaarli/Shaarli/issues/935 Signed-off-by: VirtualTam <virtualtam@flibidi.net>
This commit is contained in:
parent
e4ed3a46b7
commit
dc37a482ed
2 changed files with 10 additions and 10 deletions
14
Makefile
14
Makefile
|
@ -159,14 +159,14 @@ composer_dependencies: clean
|
|||
find vendor/ -name ".git" -type d -exec rm -rf {} +
|
||||
|
||||
### generate a release tarball and include 3rd-party dependencies
|
||||
release_tar: composer_dependencies doc_html
|
||||
release_tar: composer_dependencies htmldoc
|
||||
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 doc_html
|
||||
release_zip: composer_dependencies htmldoc
|
||||
git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
|
||||
mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor}
|
||||
rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/
|
||||
|
@ -195,17 +195,11 @@ doxygen: clean
|
|||
@rm -rf doxygen
|
||||
@( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen -
|
||||
|
||||
### Convert local markdown documentation to HTML
|
||||
#
|
||||
# For all pages:
|
||||
# - convert GitHub-flavoured relative links to standard Markdown
|
||||
# - generate html documentation with mkdocs
|
||||
htmlpages:
|
||||
### generate HTML documentation from Markdown pages with MkDocs
|
||||
htmldoc:
|
||||
python3 -m venv venv/
|
||||
bash -c 'source venv/bin/activate; \
|
||||
pip install mkdocs; \
|
||||
mkdocs build'
|
||||
find doc/html/ -type f -exec chmod a-x '{}' \;
|
||||
rm -r venv
|
||||
|
||||
doc_html: authors htmlpages
|
||||
|
|
|
@ -46,6 +46,12 @@ TBA
|
|||
|
||||
|
||||
## Increment the version code, update docs, create and push a signed tag
|
||||
### Update the list of Git contributors
|
||||
```bash
|
||||
$ make authors
|
||||
$ git commit -s -m "Update AUTHORS"
|
||||
```
|
||||
|
||||
### Create and merge a Pull Request
|
||||
This one is pretty straightforward ;-)
|
||||
|
||||
|
|
Loading…
Reference in a new issue