diff --git a/.gitlab-ci.yaml b/.gitlab-ci.yaml new file mode 100644 index 0000000000000000000000000000000000000000..633b942cb3dce93f8fdfeb14f48b9cc3668e84d1 --- /dev/null +++ b/.gitlab-ci.yaml @@ -0,0 +1,15 @@ +image: pyhton:3.9 + +pages: + stage: deploy + before_script: + - pip install -r requirement.txt + - pip install -e '.[docs]' + script: + - mkdocs build --site-dir public + artifacts: + paths: + - public + # rules: + # - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' + diff --git a/.python-version b/.python-version new file mode 100644 index 0000000000000000000000000000000000000000..bd28b9c5c27e0dfa60da94179ec9b23f2be8be0c --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.9 diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000000000000000000000000000000000000..5288ddcc01e3c1a12ea7e1436a41ffe6d02eab1d --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,12 @@ +{ + "yaml.schemas": { + "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" + }, + "yaml.customTags": [ + "!ENV scalar", + "!ENV sequence", + "tag:yaml.org,2002:python/name:materialx.emoji.to_svg", + "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", + "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" + ] + } diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000000000000000000000000000000000..b9121545bb007f3d42976795c82b25895688127d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,33 @@ +# Project information +site_name: Atomistic features package +site_url: https://squidfunk.github.io/mkdocs-material/ + +# Repository +repo_name: atomic-features-package +repo_url: https://gitlab.mpcdf.mpg.de/nomad-lab/ai-toolkit/atomic-features-package + + +# Configuration +theme: + name: material + icon: + repo: fontawesome/brands/gitlab + + +# Plugins +plugins: +- search +- mkdocstrings + + +# Extensions +markdown_extensions: + - pymdownx.snippets + + +# Page tree +nav: + - Home: index.md + - Getting started: getting_started.md + - Atomic features: atomicfeatures.md + - Metainfo: metainfo.md diff --git a/requirements.txt b/requirements.txt index acda1d582796a436d2c07f434bbc936ad2c2e6e3..dfc008aa7bec822980e02367de66b2222b2af23a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with python 3.10 +# This file is autogenerated by pip-compile with python 3.9 # To update, run: # # pip-compile pyproject.toml