Skip to content

Commit

Permalink
DOC: Build with LFS
Browse files Browse the repository at this point in the history
  • Loading branch information
benoit9126 committed Dec 2, 2024
1 parent c7d4e52 commit 8be74de
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions doc/models/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Models

A description of the electrical models used for each component is available:

```{toctree}
Expand Down
2 changes: 2 additions & 0 deletions doc/usage/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Usage

This section provides some tutorials to start using _Roseau_Load_Flow_:

```{toctree}
Expand Down

0 comments on commit 8be74de

Please sign in to comment.