Skip to content

Commit 689bbd0

Browse files
jgebaljgebal
committed
Fixing documentation build process
Resolves: #1237
1 parent de65f14 commit 689bbd0

File tree

4 files changed

+120
-38
lines changed

4 files changed

+120
-38
lines changed

‎.github/workflows/build.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -245,11 +245,13 @@ jobs:
245245
git commit -m 'Updated project version after build [skip ci]'
246246
git push --quiet origin HEAD:${CI_ACTION_REF_NAME}
247247
248-
- name: Copy and push documentation to utPLSQL-github-io repo
249-
id: push-documentation
250-
env:
251-
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
252-
run: .github/scripts/push_docs_to_github_io.sh
248+
- name: Build and publish documentation
249+
run: |
250+
pip install mkdocs
251+
pip install mkdocs-git-revision-date-localized-plugin
252+
pip install mkdocs-material
253+
pip install mike
254+
mike deploy -p develop
253255
254256
dispatch:
255257
name: Dispatch downstream builds

‎.github/workflows/release.yml

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,6 @@ defaults:
1010

1111
jobs:
1212

13-
publish:
14-
name: Deploy documentation
15-
concurrency: publish
16-
runs-on: ubuntu-latest
17-
18-
steps:
19-
- uses: actions/checkout@v2
20-
with:
21-
fetch-depth: 0
22-
- uses: c-py/action-dotenv-to-setenv@v2
23-
with:
24-
env-file: .github/variables/.env
25-
- uses: FranzDiebold/github-env-vars-action@v2 #https://github.com/marketplace/actions/github-environment-variables-action
26-
27-
- name: Set buid version number env variables
28-
run: .github/scripts/set_version_numbers_env.sh
29-
30-
- name: Setup git config
31-
run: |
32-
git config --global user.email "github-actions[bot]@users.noreply.github.com"
33-
git config --global user.name "github-actions[bot]"
34-
35-
- name: Update project version & build number in source code and documentation
36-
run: .github/scripts/update_project_version.sh
37-
38-
- name: Copy and push documentation to utPLSQL-github-io repo
39-
env:
40-
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
41-
run: .github/scripts/push_docs_to_github_io.sh
42-
4313
upload_artifacts:
4414
name: Upload archives
4515
concurrency: upload
@@ -54,7 +24,7 @@ jobs:
5424
env-file: .github/variables/.env
5525
- uses: FranzDiebold/github-env-vars-action@v2 #https://github.com/marketplace/actions/github-environment-variables-action
5626

57-
- name: Set buid version number env variables
27+
- name: Set build version number env variables
5828
run: .github/scripts/set_version_numbers_env.sh
5929

6030
- name: Update project version & build number in source code and documentation
@@ -65,10 +35,14 @@ jobs:
6535
git config --global user.email "github-actions[bot]@users.noreply.github.com"
6636
git config --global user.name "github-actions[bot]"
6737
68-
- name: Build html documentation
38+
- name: Build and publish documentation
6939
run: |
7040
pip install mkdocs
71-
mkdocs build --clean --strict
41+
pip install mkdocs-git-revision-date-localized-plugin
42+
pip install mkdocs-material
43+
pip install mike
44+
mike deploy -p -u ${UTPLSQL_VERSION} latest
45+
mkdocs build --clean -f mkdocs_offline.yml
7246
rm -rf docs/*
7347
cp -r -v site/* docs
7448
git add .

‎mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Format documented here
22
# http://www.mkdocs.org/user-guide/configuration/
33
# https://squidfunk.github.io/mkdocs-material/getting-started/
4+
# See this document for list of plugins to disable for offline (local) documentation
5+
# https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/
46

7+
edit_uri: ""
58
site_url: http://utPLSQL.org/
69
site_name: utPLSQL-framework
710
site_description: utPLSQL Ultimate Testing Framework for Oracle PL/SQL & SQL

‎mkdocs_offline.yml

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Format documented here
2+
# http://www.mkdocs.org/user-guide/configuration/
3+
# https://squidfunk.github.io/mkdocs-material/getting-started/
4+
# See this document for list of plugins to disable for offline (local) documentation
5+
# https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/
6+
7+
edit_uri: ""
8+
site_url: http://utPLSQL.org/
9+
site_name: utPLSQL-framework
10+
site_description: utPLSQL Ultimate Testing Framework for Oracle PL/SQL & SQL
11+
copyright: Copyright © 2016 - 2022 utPLSQL Team
12+
#repo_url: https://github.com/utPLSQL/utPLSQL # disable for offline docs
13+
extra_css:
14+
- stylesheets/extra.css
15+
theme:
16+
name: material
17+
palette:
18+
# Palette toggle for light mode
19+
- media: "(prefers-color-scheme: light)"
20+
scheme: default
21+
toggle:
22+
icon: material/lightbulb-outline
23+
name: Switch to dark mode
24+
# Palette toggle for dark mode
25+
- media: "(prefers-color-scheme: dark)"
26+
scheme: slate
27+
toggle:
28+
icon: material/lightbulb
29+
name: Switch to light mode
30+
logo: assets/icon-transparent.png
31+
favicon: assets/favicon.png
32+
features:
33+
# - navigation.instant # disable for offline docs
34+
# - navigation.indexes
35+
- navigation.tabs
36+
- navigation.tracking
37+
- toc.follow
38+
- toc.integrate
39+
- search.suggest
40+
- search.highlight
41+
extra:
42+
# homepage: http://jgebal.github.io/
43+
# homepage: http://utPLSQL.org/
44+
social:
45+
- icon: fontawesome/brands/twitter
46+
link: https://twitter.com/utPLSQL
47+
- icon: fontawesome/brands/slack
48+
link: https://join.slack.com/t/utplsql/shared_invite/zt-xwm68udy-4cF_3PNEyczYEbWr38W5ww
49+
- icon: fontawesome/brands/github
50+
link: https://github.com/utPLSQL
51+
- icon: fontawesome/solid/envelope
52+
link: mailto:utPLSQL@utPLSQL.org
53+
consent:
54+
title: Cookie consent
55+
description: >-
56+
We use cookies to recognize your repeated visits and preferences, as well
57+
as to measure the effectiveness of our documentation and whether users
58+
find what they're searching for. With your consent, you're helping us to
59+
make our documentation better.
60+
# version: # disable for offline docs
61+
# provider: mike # disable for offline docs
62+
markdown_extensions:
63+
- pymdownx.highlight:
64+
anchor_linenums: true
65+
- pymdownx.inlinehilite
66+
- pymdownx.snippets
67+
- pymdownx.superfences
68+
- pymdownx.caret
69+
- pymdownx.mark
70+
- pymdownx.tilde
71+
- toc:
72+
permalink: true
73+
use_directory_urls: false
74+
strict: true
75+
76+
plugins:
77+
# - search # disable for offline docs
78+
- mike
79+
# - git-revision-date-localized: # disable for offline docs
80+
# enable_creation_date: true # disable for offline docs
81+
# type: datetime # disable for offline docs
82+
83+
nav:
84+
- User Guide:
85+
- index.md
86+
- Installation: userguide/install.md
87+
- Getting Started: userguide/getting-started.md
88+
- Annotations: userguide/annotations.md
89+
- Expectations: userguide/expectations.md
90+
- Advanced data comparison: userguide/advanced_data_comparison.md
91+
- Running unit tests: userguide/running-unit-tests.md
92+
- Querying for test suites: userguide/querying_suites.md
93+
- Testing best practices: userguide/best-practices.md
94+
- Upgrade utPLSQL: userguide/upgrade.md
95+
- Reporting:
96+
- Using reporters: userguide/reporters.md
97+
- Code coverage: userguide/coverage.md
98+
- Error handling and reporting: userguide/exception-reporting.md
99+
- About:
100+
- Project Details: about/project-details.md
101+
- License: about/license.md
102+
- Support: about/support.md
103+
- Authors: about/authors.md

0 commit comments

Comments
 (0)