Commit 9d7721a5 authored by Adrian DC's avatar Adrian DC
Browse files

docs(mkdocs, pages): use 'MKDOCS_EXPORTER_PDF_OUTPUT' for PDF file 

Signed-off-by: default avatarAdrian DC <radian.dc@gmail.com>
parent 5ba91c94

.gitignore

+1
Changes for .gitignore: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -14,6 +14,7 @@ coverage-reports/ 
dist/



# Documentation intermediates

/docs/.pages

/docs/.serve.pid

/docs/about

/docs/assets/stylesheets/variables.scss

.gitlab-ci.yml

+2 −1
Changes for .gitlab-ci.yml: 2 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -910,6 +910,7 @@ pages: 
  variables:

    CI_LOCAL_NETWORK: 'host'

    MKDOCS_EXPORTER_PDF_ENABLED: 'true'

    MKDOCS_EXPORTER_PDF_OUTPUT: 'documentation.pdf'

  script:

    # Fetch all tags

    - |
@@ -975,7 +976,7 @@ pdf: 
  artifacts:

    expire_in: 1 hour

    paths:

      - public/documentation.pdf

      - public/$MKDOCS_EXPORTER_PDF_OUTPUT

  rules:

    - if: $CI_COMMIT_TAG

    - if: $CI_COMMIT_BRANCH

docs/.pages→docs/.pages.in

+1 −1
Changes for docs/.pages.in: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -6,4 +6,4 @@ nav: 
      - ‣ Changelog: about/changelog/

      - ‣ License: about/license/

      - ‣ Quality: about/quality/

      - ‣ Export as PDF: documentation.pdf
 
      - ‣ Export as PDF: !MKDOCS_EXPORTER_PDF_OUTPUT!

docs/prepare.sh

+5
Changes for docs/prepare.sh: 5 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -11,6 +11,7 @@ docs_path=$(cd "$(dirname "${BASH_SOURCE:-${0}}")" && pwd -P) 
root_path="${docs_path%/*}"



# Prepare cache

rm -f "${docs_path}/.pages"

rm -f "${docs_path}/index.md"

rm -rf "${docs_path}/about"

rm -f "${docs_path}/assets/stylesheets/variables.scss"
@@ -43,6 +44,10 @@ projectYear=$(date '+%Y') 
  echo "\$projectYear: '${projectYear}';"

} >"${docs_path}/assets/stylesheets/variables.scss"



# Prepare pages

cp -f "${docs_path}/.pages.in" "${docs_path}/.pages"

sed -i "s/!MKDOCS_EXPORTER_PDF_OUTPUT!/${MKDOCS_EXPORTER_PDF_OUTPUT:?}/g" "${docs_path}/.pages"



# Export usage

cp -f "${root_path}/README.md" "${docs_path}/index.md"

sed -i "s#\(\[.*\]\)(.*/docs/#\1(#g" "${docs_path}/index.md"

mkdocs.yml

+1 −1
Changes for mkdocs.yml: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -107,7 +107,7 @@ plugins: 
            debug: false

          aggregator:

            enabled: true # !ENV [MKDOCS_EXPORTER_PDF_AGGREGATOR, true]

            output: documentation.pdf

            output: !ENV [MKDOCS_EXPORTER_PDF_OUTPUT, 'documentation.pdf']

            covers: book

      buttons:

        - title: View as PDF