mirror of
https://gitlab.easter-eggs.com/ee/ldapsaisie.git
synced 2024-11-24 02:49:07 +01:00
Use mkdocs print-site plugin to build all-in-one version of the documentation
This commit is contained in:
parent
7588deba34
commit
c8c1c1320a
5 changed files with 22 additions and 0 deletions
|
@ -94,9 +94,11 @@ build:doc:
|
||||||
script:
|
script:
|
||||||
- cd doc
|
- cd doc
|
||||||
- mkdocs build -s
|
- mkdocs build -s
|
||||||
|
- htmlark public_html/print_page/index.html -o LdapSaisie.html
|
||||||
artifacts:
|
artifacts:
|
||||||
paths:
|
paths:
|
||||||
- doc/public_html/
|
- doc/public_html/
|
||||||
|
- doc/LdapSaisie.html
|
||||||
|
|
||||||
deploy:doc:
|
deploy:doc:
|
||||||
stage: deploy
|
stage: deploy
|
||||||
|
@ -109,3 +111,4 @@ deploy:doc:
|
||||||
- echo "$SSH_HOST_KEY" | base64 -d > ~/.ssh/known_hosts
|
- echo "$SSH_HOST_KEY" | base64 -d > ~/.ssh/known_hosts
|
||||||
script:
|
script:
|
||||||
- rsync -atv --exclude '.git*' --delete --progress ./doc/public_html/ $SSH_USER@$SSH_HOST:./
|
- rsync -atv --exclude '.git*' --delete --progress ./doc/public_html/ $SSH_USER@$SSH_HOST:./
|
||||||
|
- rsync -atv ./doc/LdapSaisie.html $SSH_USER@$SSH_HOST:LdapSaisie.html
|
||||||
|
|
1
doc/.gitignore
vendored
1
doc/.gitignore
vendored
|
@ -1 +1,2 @@
|
||||||
public_html
|
public_html
|
||||||
|
LdapSaisie.html
|
||||||
|
|
|
@ -20,6 +20,7 @@ plugins:
|
||||||
- search:
|
- search:
|
||||||
lang: fr # Set language for search
|
lang: fr # Set language for search
|
||||||
- include-markdown
|
- include-markdown
|
||||||
|
- print-site
|
||||||
|
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
|
|
12
doc/overrides/main.html
Normal file
12
doc/overrides/main.html
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
|
||||||
|
{% if page.url_to_print_page %}
|
||||||
|
<a href="{{ page.url_to_print_page }}" title="Print Site" class="md-content__button md-icon">
|
||||||
|
{% include ".icons/material/printer.svg" %}
|
||||||
|
</a>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{{ super() }}
|
||||||
|
{% endblock content %}
|
|
@ -2,3 +2,8 @@ mkdocs
|
||||||
mkdocs-material
|
mkdocs-material
|
||||||
mdx_truly_sane_lists
|
mdx_truly_sane_lists
|
||||||
mkdocs-include-markdown-plugin
|
mkdocs-include-markdown-plugin
|
||||||
|
mkdocs-print-site-plugin
|
||||||
|
# For building all-in-one HTML file
|
||||||
|
html5lib
|
||||||
|
requests
|
||||||
|
htmlark
|
||||||
|
|
Loading…
Reference in a new issue