Browse Source

Generate man pages (#13901)

* extend gitignore

* first working draft

* use docs subcomand

* rm config-sheet-sheet-2-man
tags/v1.15.0-dev
6543 GitHub 4 years ago
parent
commit
559143b5e0
2 changed files with 13 additions and 1 deletions
  1. +3
    -0
      .gitignore
  2. +10
    -1
      Makefile

+ 3
- 0
.gitignore View File

@@ -106,3 +106,6 @@ prime/

# Make evidence files
/.make_evidence

# Manpage
/man

+ 10
- 1
Makefile View File

@@ -178,6 +178,7 @@ help:
@echo " - fmt format the Go code"
@echo " - generate-license update license files"
@echo " - generate-gitignore update gitignore files"
@echo " - generate-manpage generate manpage"
@echo " - generate-swagger generate the swagger spec from code comments"
@echo " - swagger-validate check if the swagger spec is valid"
@echo " - golangci-lint run golangci-lint linter"
@@ -223,7 +224,7 @@ clean:
integrations*.test \
integrations/gitea-integration-pgsql/ integrations/gitea-integration-mysql/ integrations/gitea-integration-mysql8/ integrations/gitea-integration-sqlite/ \
integrations/gitea-integration-mssql/ integrations/indexers-mysql/ integrations/indexers-mysql8/ integrations/indexers-pgsql integrations/indexers-sqlite \
integrations/indexers-mssql integrations/mysql.ini integrations/mysql8.ini integrations/pgsql.ini integrations/mssql.ini
integrations/indexers-mssql integrations/mysql.ini integrations/mysql8.ini integrations/pgsql.ini integrations/mssql.ini man/

.PHONY: fmt
fmt:
@@ -702,6 +703,14 @@ generate-images:
npm install --no-save --no-package-lock fabric imagemin-zopfli
node build/generate-images.js $(TAGS)

.PHONY: generate-manpage
generate-manpage:
@[ -f gitea ] || make backend
@mkdir -p man/man1/ man/man5
@./gitea docs --man > man/man1/gitea.1
@gzip -9 man/man1/gitea.1 && echo man/man1/gitea.1.gz created
@#TODO A smal script witch format config-cheat-sheet.en-us.md nicely to suit as config man page

.PHONY: pr\#%
pr\#%: clean-all
$(GO) run contrib/pr/checkout.go $*


Loading…
Cancel
Save