Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
uv pip install -e .

- name: Generate docs content
run: uv run python docs/generate.py
run: uv run markdown-code-runner docs/*.md

- name: Build documentation
run: uv run zensical build
Expand Down
6 changes: 2 additions & 4 deletions docs/backup-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ rsync-time-machine uses an intelligent backup expiration strategy to manage disk
## Backup Expiration Logic

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("expiration")) -->
<!-- print(include_section("../README.md", "expiration", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -21,8 +20,7 @@ Backup sets are automatically deleted following a simple expiration strategy def
## No Automatic Backup Expiration

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("no-auto-expire")) -->
<!-- print(include_section("../README.md", "no-auto-expire", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand Down
6 changes: 2 additions & 4 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ icon: lucide/heart-handshake
# Contributing

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("support")) -->
<!-- print(include_section("../README.md", "support", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -15,8 +14,7 @@ We appreciate your feedback and contributions! If you encounter any issues or ha
<!-- OUTPUT:END -->

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("contributing")) -->
<!-- print(include_section("../README.md", "contributing", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand Down
73 changes: 0 additions & 73 deletions docs/generate.py

This file was deleted.

6 changes: 2 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ This guide will help you install and start using rsync-time-machine in minutes.
## Installation

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("installation")) -->
<!-- print(include_section("../README.md", "installation", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -34,8 +33,7 @@ and use it like `./rsync_time_machine.py --help`
## Quick Start

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("examples")) -->
<!-- print(include_section("../README.md", "examples", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand Down
18 changes: 7 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,15 @@ icon: lucide/clock
**Time Machine-style backups using rsync**

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("intro")) -->
<!-- print(include_section("../README.md", "intro", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Introducing `rsync-time-machine.py` - a Python port of the [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) script, offering Time Machine-style backups using rsync. It creates incremental backups of files and directories to the destination of your choice. The backups are structured in a way that makes it easy to recover any file at any point in time. 🚀
Introducing `rsync-time-machine.py` - a Python port of the [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) script, offering Time Machine-style backups using rsync. It creates incremental backups of files and directories to the destination of your choice. The backups are structured in a way that makes it easy to recover any file at any point in time.

It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage over Time Machine is flexibility, as it can backup from/to any filesystem and works on any platform. You can also backup to a Truecrypt drive without any problem. 😃
It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage over Time Machine is flexibility, as it can backup from/to any filesystem and works on any platform. You can also backup to a Truecrypt drive without any problem.

`rsync-time-machine.py` is fully tested, has no external dependencies (only Python ≥3.7 🐍), is fully compatible with [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup), offers pretty terminal output, and is fully typed! 🎉
`rsync-time-machine.py` is fully tested, has no external dependencies (only Python ≥3.7), is fully compatible with [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup), offers pretty terminal output, and is fully typed!

<!-- OUTPUT:END -->

Expand All @@ -32,8 +31,7 @@ It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage ov
## Features

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("features")) -->
<!-- print(include_section("../README.md", "features", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -51,8 +49,7 @@ It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage ov
## Featured on

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("featured")) -->
<!-- print(include_section("../README.md", "featured", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -65,8 +62,7 @@ It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage ov
## Support and Contributions

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("support")) -->
<!-- print(include_section("../README.md", "support", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand Down
14 changes: 5 additions & 9 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,7 @@ options:
## Exclusion File

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("exclusion")) -->
<!-- print(include_section("../README.md", "exclusion", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -90,7 +89,7 @@ An optional exclude file can be provided as a third parameter, compatible with t
The `--exclude-from` option in `rsync-time-machine.py` allows you to exclude specific files or directories from the backup process. You can provide an exclusion file containing patterns for files or directories that should be excluded.

<details>
<summary>📖🔽 Click here to expand the docs on <code>--exclude-from</code> 🔽📖</summary>
<summary>Click here to expand the docs on <code>--exclude-from</code></summary>

Here's how to use the `--exclude-from` feature in `rsync-time-machine.py`:

Expand Down Expand Up @@ -131,8 +130,7 @@ See [this tutorial](https://web.archive.org/web/20230126121643/https://sites.goo
## Built-in Lock

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("lock")) -->
<!-- print(include_section("../README.md", "lock", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -143,8 +141,7 @@ The script is designed so that only one backup operation can be active for a giv
## Rsync Options

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("rsync-options")) -->
<!-- print(include_section("../README.md", "rsync-options", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand All @@ -155,8 +152,7 @@ To display, add, or remove rsync options, use the `--rsync-get-flags`, `--rsync-
## How to Restore

<!-- CODE:START -->
<!-- from generate import readme_section -->
<!-- print(readme_section("restore")) -->
<!-- print(include_section("../README.md", "restore", strip_heading=True)) -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ test = ["pytest", "pre-commit", "coverage", "pytest-cov"]
docs = [
"zensical; python_version >= '3.9'",
"markdown-gfm-admonition; python_version >= '3.9'",
"markdown-code-runner; python_version >= '3.9'",
"markdown-code-runner>=2.7.0; python_version >= '3.9'",
]

[project.scripts]
Expand Down
8 changes: 4 additions & 4 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading