Skip to content

Commit

Permalink
Update 4 files
Browse files Browse the repository at this point in the history
- /.gitlab/merge_request_templates/merge_request_template.md
- /requirements/requirements_doc.in
- /requirements/requirements_doc.txt
- /.github/workflows/publish-doc.yaml
  • Loading branch information
jmaunon committed Mar 20, 2024
1 parent 7ec6020 commit ca00e48
Show file tree
Hide file tree
Showing 4 changed files with 233 additions and 30 deletions.
17 changes: 4 additions & 13 deletions .github/workflows/publish-doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,21 @@ on:
push:
branches:
- develop

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2

- name: Set up GCC
uses: egor-tensin/setup-gcc@v1
with:
version: latest
platform: x64

- name: Install wheel
run: |
pip install wheel

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: mkdocs.yml
EXTRA_PACKAGES: gcc python3-dev musl-dev linux-headers
# GITHUB_DOMAIN: github.myenterprise.com
REQUIREMENTS: requirements/requirements_dev.txt
REQUIREMENTS: requirements/requirements_doc.txt
17 changes: 0 additions & 17 deletions .gitlab/merge_request_templates/merge_request_template.md

This file was deleted.

3 changes: 3 additions & 0 deletions requirements/requirements_doc.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs==1.5.3 # Documentation
mkdocs-material==9.5.13 # Documentation theme
mkdocs-jupyter==0.24.6 # Jupyter notebooks
226 changes: 226 additions & 0 deletions requirements/requirements_doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile requirements/requirements_doc.in
#
asttokens==2.4.1
# via stack-data
attrs==23.2.0
# via
# jsonschema
# referencing
babel==2.14.0
# via mkdocs-material
beautifulsoup4==4.12.3
# via nbconvert
bleach==6.1.0
# via nbconvert
certifi==2024.2.2
# via requests
charset-normalizer==3.3.2
# via requests
click==8.1.7
# via mkdocs
colorama==0.4.6
# via mkdocs-material
comm==0.2.2
# via ipykernel
debugpy==1.8.1
# via ipykernel
decorator==5.1.1
# via ipython
defusedxml==0.7.1
# via nbconvert
exceptiongroup==1.2.0
# via ipython
executing==2.0.1
# via stack-data
fastjsonschema==2.19.1
# via nbformat
ghp-import==2.1.0
# via mkdocs
idna==3.6
# via requests
ipykernel==6.29.3
# via mkdocs-jupyter
ipython==8.22.2
# via ipykernel
jedi==0.19.1
# via ipython
jinja2==3.1.3
# via
# mkdocs
# mkdocs-material
# nbconvert
jsonschema==4.21.1
# via nbformat
jsonschema-specifications==2023.12.1
# via jsonschema
jupyter-client==8.6.1
# via
# ipykernel
# nbclient
jupyter-core==5.7.2
# via
# ipykernel
# jupyter-client
# nbclient
# nbconvert
# nbformat
jupyterlab-pygments==0.3.0
# via nbconvert
jupytext==1.16.1
# via mkdocs-jupyter
markdown==3.6
# via
# mkdocs
# mkdocs-material
# pymdown-extensions
markdown-it-py==3.0.0
# via
# jupytext
# mdit-py-plugins
markupsafe==2.1.5
# via
# jinja2
# mkdocs
# nbconvert
matplotlib-inline==0.1.6
# via
# ipykernel
# ipython
mdit-py-plugins==0.4.0
# via jupytext
mdurl==0.1.2
# via markdown-it-py
mergedeep==1.3.4
# via mkdocs
mistune==3.0.2
# via nbconvert
mkdocs==1.5.3
# via
# -r requirements/requirements_doc.in
# mkdocs-jupyter
# mkdocs-material
mkdocs-jupyter==0.24.6
# via -r requirements/requirements_doc.in
mkdocs-material==9.5.13
# via
# -r requirements/requirements_doc.in
# mkdocs-jupyter
mkdocs-material-extensions==1.3.1
# via mkdocs-material
nbclient==0.10.0
# via nbconvert
nbconvert==7.16.2
# via mkdocs-jupyter
nbformat==5.10.3
# via
# jupytext
# nbclient
# nbconvert
nest-asyncio==1.6.0
# via ipykernel
packaging==24.0
# via
# ipykernel
# jupytext
# mkdocs
# nbconvert
paginate==0.5.6
# via mkdocs-material
pandocfilters==1.5.1
# via nbconvert
parso==0.8.3
# via jedi
pathspec==0.12.1
# via mkdocs
pexpect==4.9.0
# via ipython
platformdirs==4.2.0
# via
# jupyter-core
# mkdocs
prompt-toolkit==3.0.43
# via ipython
psutil==5.9.8
# via ipykernel
ptyprocess==0.7.0
# via pexpect
pure-eval==0.2.2
# via stack-data
pygments==2.17.2
# via
# ipython
# mkdocs-jupyter
# mkdocs-material
# nbconvert
pymdown-extensions==10.7.1
# via mkdocs-material
python-dateutil==2.9.0.post0
# via
# ghp-import
# jupyter-client
pyyaml==6.0.1
# via
# jupytext
# mkdocs
# pymdown-extensions
# pyyaml-env-tag
pyyaml-env-tag==0.1
# via mkdocs
pyzmq==25.1.2
# via
# ipykernel
# jupyter-client
referencing==0.34.0
# via
# jsonschema
# jsonschema-specifications
regex==2023.12.25
# via mkdocs-material
requests==2.31.0
# via mkdocs-material
rpds-py==0.18.0
# via
# jsonschema
# referencing
six==1.16.0
# via
# asttokens
# bleach
# python-dateutil
soupsieve==2.5
# via beautifulsoup4
stack-data==0.6.3
# via ipython
tinycss2==1.2.1
# via nbconvert
toml==0.10.2
# via jupytext
tornado==6.4
# via
# ipykernel
# jupyter-client
traitlets==5.14.2
# via
# comm
# ipykernel
# ipython
# jupyter-client
# jupyter-core
# matplotlib-inline
# nbclient
# nbconvert
# nbformat
urllib3==2.2.1
# via requests
watchdog==4.0.0
# via mkdocs
wcwidth==0.2.13
# via prompt-toolkit
webencodings==0.5.1
# via
# bleach
# tinycss2

0 comments on commit ca00e48

Please sign in to comment.