Browse Source

Refine the install guide

biotorrents 3 years ago
parent
commit
9dbe1a52a0
4 changed files with 27 additions and 13 deletions
  1. 1
    0
      .gitignore
  2. 0
    0
      docs/dl/sphinx.conf
  3. 11
    3
      docs/install.md
  4. 15
    10
      mkdocs.yml

+ 1
- 0
.gitignore View File

@@ -1,3 +1,4 @@
1 1
 *.sw*
2 2
 .DS_Store
3
+docs/dl/fonts.tgz
3 4
 site/

sphinx.conf → docs/dl/sphinx.conf View File


+ 11
- 3
docs/install.md View File

@@ -5,7 +5,7 @@ Gazelle is notoriously difficult to install and good docs are lacking.
5 5
 This page, based on the
6 6
 [original announcement protocol](https://github.com/biotorrents/announcement),
7 7
 is an attempt to make an evergreen install guide.
8
-It's fast paced and covers only the essentials.
8
+It's fast paced and only covers the essentials.
9 9
 
10 10
 # Debian system profile
11 11
 
@@ -275,7 +275,7 @@ Install Sphinx with `apt install sphinxsearch`.
275 275
 
276 276
 The `/etc/sphinxsearch/sphinx.conf` content is too large to reasonably inline.
277 277
 Please find a copy at
278
-[biotorrents/documentation](https://github.com/biotorrents/documentation/blob/master/sphinx.conf).
278
+[biotorrents/documentation](https://github.com/biotorrents/documentation/blob/master/docs/dl/sphinx.conf).
279 279
 The only other Sphinx-related configs are root crontab entries:
280 280
 
281 281
 ```crontab
@@ -377,7 +377,7 @@ Then add `/var/www/bin` to the Gazelle user's `$PATH` and run:
377 377
 
378 378
 Install SassC with `apt install sassc`.
379 379
 
380
-[Download the font pack](https://docs.biotorrents.de/fonts.tgz)
380
+[Download the font pack](https://docs.biotorrents.de/dl/fonts.tgz)
381 381
 and extract it with:
382 382
 `tar zxvf fonts.tgz -C /var/www/html/dev.biotorrents.de/static/styles/assets/fonts`.
383 383
 
@@ -470,7 +470,15 @@ Note that LibTorrent 0.1x.y also covers rTorrent/ruTorrent and other clients tha
470 470
 | qBittorrent 3.x.y | `-qB3`  |
471 471
 | qBittorrent 4.x.y | `-qB4`  |
472 472
 | Transmission 2.xy | `-TR2`  |
473
+| Transmission 3.xy | `-TR3`  |
473 474
 
474 475
 Most of the Toolbox pages don't write to the database and all of them should work.
475 476
 For more BitTorrents info see
476 477
 [Calomel's rTorrent hacking guide](https://calomel.org/rtorrent_mods.html).
478
+
479
+## Building this documentation
480
+
481
+[biotorrents/documentation](https://github.com/biotorrents/documentation)
482
+has the Mkdocs source code.
483
+Install MkDocs with `apt install mkdocs`.
484
+Then do `mkdocs build`.

+ 15
- 10
mkdocs.yml View File

@@ -1,13 +1,18 @@
1
-site_name: 'Docs ⸬ BioTorrents.de'
2
-site_url: 'https://docs.biotorrents.de'
1
+strict: true
3 2
 
4
-repo_name: 'Gazelle'
5
-repo_url: 'https://github.com/biotorrents/gazelle'
3
+site_name: "Docs ⸬ BioTorrents.de"
4
+site_url: "https://docs.biotorrents.de"
5
+
6
+repo_url: "https://github.com/biotorrents/gazelle"
7
+edit_uri: ""
6 8
 
7 9
 nav:
8
-  - 'index.md'
9
-  - 'torrents.md'
10
-  - 'users.md'
11
-  - 'forums.md'
12
-  - 'meta.md'
13
-  - 'install.md'
10
+  - "index.md"
11
+  - "torrents.md"
12
+  - "users.md"
13
+  - "forums.md"
14
+  - "meta.md"
15
+  - "install.md"
16
+
17
+markdown_extensions:
18
+  - smarty

Loading…
Cancel
Save