Merge pull request #99 from atcoder/patch/issue87

#87: add version into the document

Author: yosupo06

.github/workflows/artifact.yml

@@ -1,40 +1,43 @@
 name: Document
 
-on:
-  push:
-    branches:
-      - master
-      - production
-    tags:
-      - 'v*'
+on: [push, pull_request]
 
 jobs:
   doc:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Set branch name
-        id: branch
-        run: echo "::set-output name=BRANCH_NAME::${GITHUB_REF##*/}"
-      - name: Set up Python 3.7
+      - name: Set version name
+        id: version
+        run: echo "::set-output name=VERSION_NAME::${GITHUB_REF##*/}"
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.9
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install --user -r tools/requirements.txt
       - name: Generate documents (and remove markdown)
         run: |
           cd tools &&
-          ./generate_document.py &&
+          ./generate_document.py --tag $VERSION &&
+          ./generate_zip.py &&
           rm ../document_ja/*.md ../document_en/*.md &&
           mkdir generated &&
           mv ../document_ja generated/ &&
           mv ../document_en generated/
+        env:
+          VERSION: ${{ steps.version.outputs.VERSION_NAME }}
       - name: Publish to github pages
+        if: ${{ github.event_name == 'push' }}
         uses: peaceiris/actions-gh-pages@v3
         with:
           deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
           publish_dir: ./tools/generated
-          destination_dir: ${{ steps.branch.outputs.BRANCH_NAME }}
+          destination_dir: ${{ steps.version.outputs.VERSION_NAME }}
+      - name: Upload zip
+        uses: actions/upload-artifact@v2
+        with:
+          name: ac-library
+          path: tools/ac-library.zip

.github/workflows/document.yml

@@ -1,4 +1,6 @@
-# AC(AtCoder) Library Document
+# AC(AtCoder) Library Document (@{keyword.tag})
+
+@{keyword.info}
 
 ## How to Install
 

document_en/index.md

@@ -1,3 +1,4 @@
 constraints = 'Constraints'
 complexity = 'Complexity'
 examples = 'Examples'
+info = '*The version of this document may differ from the one which is installed in AtCoder, AtCoder-installed version is [here](https://atcoder.github.io/ac-library/production/document_ja/).*'

document_en/keywords.toml

@@ -1,4 +1,6 @@
-# AC(AtCoder) Library Document
+# AC(AtCoder) Library Document (@{keyword.tag})
+
+@{keyword.info}
 
 ## インストール方法
 

document_ja/index.md

@@ -1,3 +1,4 @@
 constraints = '制約'
 complexity = '計算量'
 examples = '使用例'
+info = '*このドキュメントの内容は AtCoder にインストールされているものとバージョンが異なる可能性があります。 AtCoder にインストールされているバージョンは [こちら](https://atcoder.github.io/ac-library/production/document_ja/) を参照してください*'

document_ja/keywords.toml

@@ -2,6 +2,8 @@
 
 from logging import Logger, basicConfig, getLogger
 from os import getenv
+import argparse
+import re
 from pathlib import Path
 
 import markdown
@@ -42,8 +44,11 @@ def __getitem__(self, key: str):
 html_head = open('template_head.html', 'r').read()
 html_body = open('template_body.html', 'r').read()
 
-def convert(md_statement: str, base_dir: Path) -> str:
+def convert(md_statement: str, base_dir: Path, tag: str) -> str:
     keywords = toml.load(base_dir / 'keywords.toml')
+    keywords['tag'] = tag
+    if tag == 'production' or re.match(r'v[0-9]\.[0-9]', tag):
+        keywords['info'] = ''
 
     environment = Environment(
         variable_start_string="@{", variable_end_string="}", loader=DictLoader({'task': md_statement}))
@@ -70,6 +75,9 @@ def convert(md_statement: str, base_dir: Path) -> str:
         datefmt="%H:%M:%S",
         level=getenv('LOG_LEVEL', 'INFO'),
     )
+    parser = argparse.ArgumentParser(description='Document generator')
+    parser.add_argument('--tag', help='Library version')
+    opts = parser.parse_args()
 
     langs = ['en', 'ja']
     for lang in langs:
@@ -78,7 +86,7 @@ def convert(md_statement: str, base_dir: Path) -> str:
 
         for md_file in base_dir.glob('*.md'):
             logger.info('convert {}'.format(md_file))
-            statement = convert(open(md_file).read(), base_dir)
+            statement = convert(open(md_file).read(), base_dir, opts.tag)
 
             html_file = base_dir / (md_file.stem + '.html')
             with open(html_file, 'w') as f: