From 8be74de0a7fcbc08bd017ff20280c27ee48c2f2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Vinot?= Date: Mon, 2 Dec 2024 14:25:07 +0100 Subject: [PATCH] DOC: Build with LFS --- .readthedocs.yaml | 20 ++++++++++++++++++++ doc/models/index.md | 2 ++ doc/usage/index.md | 2 ++ 3 files changed, 24 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ae9f2506..63c47f34 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,6 +6,26 @@ build: tools: python: "3.12" commands: + # + # Install git-lfs + # + # Download and uncompress the binary + # https://git-lfs.github.com/ + - wget https://github.com/git-lfs/git-lfs/releases/download/v3.6.0/git-lfs-linux-amd64-v3.6.0.tar.gz + - tar xvfz git-lfs-linux-amd64-v3.6.0.tar.gz + # Modify LFS config paths to point where git-lfs binary was downloaded + - git config filter.lfs.process "`pwd`/git-lfs filter-process" + - git config filter.lfs.smudge "`pwd`/git-lfs smudge -- %f" + - git config filter.lfs.clean "`pwd`/git-lfs clean -- %f" + # Make LFS available in current repository + - ./git-lfs-3.6.0/git-lfs install + # Download content from remote + - ./git-lfs-3.6.0/git-lfs fetch + # Make local files to have the real content on them + - ./git-lfs-3.6.0/git-lfs checkout + # + # Build using uv + # - asdf plugin add uv - asdf install uv latest - asdf global uv latest diff --git a/doc/models/index.md b/doc/models/index.md index d59af337..3d98363a 100644 --- a/doc/models/index.md +++ b/doc/models/index.md @@ -1,3 +1,5 @@ +# Models + A description of the electrical models used for each component is available: ```{toctree} diff --git a/doc/usage/index.md b/doc/usage/index.md index 838b8cdc..9a781add 100644 --- a/doc/usage/index.md +++ b/doc/usage/index.md @@ -1,3 +1,5 @@ +# Usage + This section provides some tutorials to start using _Roseau_Load_Flow_: ```{toctree}