Commit Graph

97 Commits

Author SHA1 Message Date
Thomas Waldmann 4d424de69e
scripts: update docs about make.py 2024-02-09 17:37:44 +01:00
Thomas Waldmann b64f6e3335
scripts/gendocs.py: make it work
remove unused html_write function

gendocs: update developer docs
2024-02-09 17:37:38 +01:00
Thomas Waldmann 33393946b5
docs: how to run the testsuite using the dist package 2024-02-09 00:36:58 +01:00
Thomas Waldmann 576ee3532c
docs: fix markup errors 2024-01-14 17:27:21 +01:00
ebabcock93 73a416830a
docs: add typical PR workflow to development docs, fixes #7495 (#7656) 2024-01-10 00:56:18 +01:00
Thomas Waldmann 8db8fd601b
docs: OS X -> macOS 2023-07-04 23:59:44 +02:00
Thomas Waldmann 5fb4cc3b4b
docs: no signature upload on pypi any more
but we upload it on github releases,
so people can check it.
2023-07-04 20:20:35 +02:00
Thomas Waldmann 15781efab3
docs: CI only on github actions now 2023-07-04 20:11:26 +02:00
Thomas Waldmann 80188d3bdf
remove coala (outdated)
last coala release (0.11.0) is now over 6y old.

when using pip install coala, a ton of stuff gets installed (expected)
and a part of that downgrades some stuff we use to outdated, incompatible
versions.

when trying to run coala with python 3.11, it just crashes because the
last release was made for py35/py36 (as seen in their setup.py).

a lot of PRs and tickets pile up at the coala project on github,
but noone is maintaining it.
2023-07-02 17:25:51 +02:00
Michael Deyaso 98d1c65b40 Installed and configured pre-commit to lint and format code. Fixes #7476 2023-03-25 13:34:30 +03:00
Thomas Waldmann 89e4a52c56 docs: misc. updates
- remove outdated stuff
- fix infos for borg 2.0
2022-08-03 11:35:25 +02:00
Thomas Waldmann 2e063a9c44 docs: using black for code formatting 2022-07-06 16:35:31 +02:00
Thomas Waldmann dbb63f874b docs: fix rst literal blocks 2022-07-05 00:38:37 +02:00
Thomas Waldmann 64e7ccd3fc require python >= 3.9, fixes #6315 2022-02-27 18:46:30 +01:00
Thomas Waldmann 59b6dc5442 require python 3.8+, fixes #5975
if you do not have py38+ yet, just use borg 1.1.x.
2021-09-16 02:21:29 +02:00
Ryan Polley 974fd9eecb add link back to git-installation 2021-01-22 16:12:52 -06:00
Samuel fa331c3e3b
Change references of Travis to GitHub Actions (#5536)
s/travis/github actions/g, fixes #5528
2020-12-03 20:10:53 +01:00
Guinness 4212730e54
Add some documentation for new compression algorithm 2020-11-13 13:23:37 +01:00
Thomas Waldmann 9d2cabc4d2 update travis-ci.org -> .com (master) 2020-11-02 23:06:15 +01:00
Thomas Waldmann 49b1421682 FUSE: support pyfuse3 additionally to llfuse, fixes #5407
FUSE implementation can be switched via env var BORG_FUSE_IMPL.
2020-10-31 22:04:44 +01:00
Thomas Waldmann 1a8f5d27ab drop python 3.5, fixes #5344
py35 is EOL.
2020-09-25 02:13:43 +02:00
Thalian a8ecec24c2 [DOCS] #5000 – Add rendering docs to release todo
Add a line regarding checking the markup.
2020-03-18 19:54:03 +01:00
Milkey Mouse 4e95ad6230
Add updating borgbackup.org/releases to release checklist (fixes #4999) 2020-03-11 15:51:29 -07:00
Ioannis Cherouvim b586a6a20e
docs: List items consistency
Capitalized list items and finished them with a full stop. This was inconsistent.
2019-09-20 21:19:38 +03:00
ntova 627ca1376b Fix various code blocks in the docs (#4708)
Fix various code blocks in the docs

- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.

- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:13:11 +02:00
Thomas Waldmann 305efb5b01 signing binaries with Qubes OS support, docs 2019-02-11 02:44:44 +01:00
Thomas Waldmann f7525156c1 update release workflow using twine (docs, scripts), see #4213 2019-02-01 22:07:49 +01:00
Thomas Waldmann 63bdae8314 docs: fix broken links
(cherry picked from commit c7994b598b)
2017-11-27 00:00:46 +01:00
Michael Rupert 6dd54f93ce fixed support links (#3379)
fixed support links
2017-11-26 05:10:22 +01:00
Michael Rupert 71fbac94fb Moved Support to .org (#3360)
docs: moved support options to www.borgbackup.org
2017-11-25 03:15:18 +01:00
Thomas Waldmann 818b61935b update release checklist about security fixes 2017-11-06 10:38:04 +01:00
8bit 8d830d069f Removed all |project_name
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
Thomas Waldmann 112bf43956 docs: twitter account @borgbackup, fixes #2948 2017-09-22 23:36:48 +02:00
Lukas Fleischer 03dea8c78b development.rst: Miscellaneous improvements (#2944)
development.rst: misc. improvements

* Improved wording / grammar.
* Use proper Git terminology for operations on patches.
* Unify capitalization of "GitHub".
* Add proper formatting to branch names.
2017-08-19 21:12:51 +02:00
Thomas Waldmann a5c6a50ebe increase Python minimum requirement to 3.5.0
also:
- drop testing on 3.4
- add some TODO for the docs and vagrant machines
2017-07-29 20:55:04 +02:00
Marian Beermann 887df51eef docs: development: update docs remarks 2017-06-18 01:31:32 +02:00
enkore 524e0b5322 docs: development: vagrant, windows10 requirements 2017-06-08 12:27:16 +02:00
TW 28e4eb4ea3 add a .coafile for coala (#2592)
add support for using coala, fixes #1366

ignores / disable are set up so that there are not many faults.
we can improve that iteratively.
2017-06-03 15:13:21 +02:00
Thomas Waldmann 16a296c11a vagrant: control VM cpus and pytest workers via env 2017-06-02 02:34:12 +02:00
Marian Beermann 475d53d9ef docs: kill api page 2017-03-25 15:41:11 +01:00
Marian Beermann 00f98d8ad1 docs/development: update merge remarks 2017-03-10 23:26:10 +01:00
Milkey Mouse 85a2d2fc08 Add warning about running build_usage on Python >3.4 (fixes #2123)
Python 3.6 added some new guaranteed hashing algorithms that will
show up as available in the docs even though the baseline for support
is Python 3.4; running build_usage with Python 3.4 will fix this.

# Conflicts:
#	docs/development.rst
2017-03-09 21:35:33 +01:00
Marian Beermann 5e0c2d4b11 new branching model 2017-02-14 13:01:46 +01:00
Marian Beermann 847797b477 update development.rst for docs changes 2017-02-12 18:51:41 +01:00
Thomas Waldmann afab1cc9b0 Merge branch '1.0-maint'
# Conflicts:
#	borg/platform.py
#	src/borg/archiver.py
#	src/borg/helpers.py
#	src/borg/platform/darwin.pyx
#	src/borg/platform/freebsd.pyx
#	src/borg/platform/linux.pyx
#	src/borg/testsuite/__init__.py
2016-11-17 23:56:34 +01:00
Abdel-Rahman 9cf4846c27 Typo 2016-11-15 00:11:32 +02:00
Thomas Waldmann c81f861ba6 developers docs: clarify how to choose PR target branch 2016-11-14 03:26:39 +01:00
Marian Beermann c2eb2539b9
Document maintenance merge command 2016-11-13 16:07:06 +01:00
Thomas Waldmann 2a864be84f Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	setup.py
#	src/borg/archiver.py
#	src/borg/helpers.py
2016-09-27 21:31:41 +02:00
Martin Hostettler 4f9f25db02 development.rst: Add sphinx_rtd_theme to the sphinx install command
It’s used by default, so install it as well.
2016-09-25 21:45:15 +02:00