228 Commits

Author SHA1 Message Date
mauwii
ead0e92bac
remove feature list from index.md since in menu
fix double bs python path in cli.md and fix tables again
add more keys in cli.md
fix annotations in install_mac.md
remove torchaudio from pythorch-nightly installation
fix self reference
2022-09-19 08:36:42 +02:00
mauwii
6ea0a7699e
add Icons to Titles and in index.md 2022-09-18 21:30:18 +02:00
Armando C. Santisbon
20ffd4082c needs protobuf 3.20.1 2022-09-18 13:25:21 -05:00
mauwii
578638c258
include rust inst. step in standalone installation
also include protobuf uninstall if installed previously
2022-09-18 18:48:05 +02:00
mauwii
016fd65f6a
use more admonitions and introduce keys 2022-09-18 11:09:27 +02:00
mauwii
dbc9134630
add previously missed admonition 2022-09-18 05:06:54 +02:00
mauwii
0071f43b2c
use Admonitions for notes, warnings, ... 2022-09-18 04:54:20 +02:00
mauwii
6d09f8c6b2
some smaller fixes to linux and windows install 2022-09-18 04:09:42 +02:00
mauwii
ed8ee8c690
update install-mode refference 2022-09-17 07:55:55 +02:00
mauwii
b9183b00a0
add Content tabs 2022-09-17 06:34:38 +02:00
mauwii
17e755e062
shorten long commands in codeblocks
this way it looks much better in MkDocs Codeblocks (and ofc still works)
also remove a markdown styled link from a bash-codeblock
2022-09-17 03:05:13 +02:00
mauwii
ae963fcfdc
fix codeblock anotations 2022-09-17 02:56:02 +02:00
mauwii
3c732500e7
many updatedes to INSTALL_MAC.md 2022-09-17 02:46:59 +02:00
mauwii
cd494c2f6c
fix some markdown violations as well 2022-09-17 02:34:25 +02:00
mauwii
fa7fe382b7
remove protobuf from brew install docs 2022-09-17 02:10:16 +02:00
Lincoln Stein
df4c80f177 respect --outdir again; fix issue #628 2022-09-16 19:58:45 -04:00
Armando C. Santisbon
fb7a9f37e4 Set temporary instructions
Set temporary instructions to use the branch that can currently be
containerized.
2022-09-16 18:35:50 -05:00
SteveCaruso
40b61870f6
update Intel Mac instructions (#599)
Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-16 17:42:21 -04:00
冯不游
6cab2e0ca0
refine env rebuild tip (#611) 2022-09-16 17:32:52 -04:00
Matthias Wild
ec2dc24ad7
Mkdocs-material (#575)
* Squashed commit of the following:

commit 82d9c25d9a87ea5f6fbdb0445313e48cd8ae3035
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:29:11 2022 +0200

    fix branch name in mkdocs-flow

commit 2e276cecc1942050ae8b22f4a417c576c49763a1
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:28:35 2022 +0200

    fix theme name

commit 2eb77c1173598e161e8a5a9812b021b831363183
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:14:42 2022 +0200

    fixed some links and formating in main README

commit 66a7152e48e8c66c9286f47a6b088920a8fcdcd8
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 08:58:58 2022 +0200

    trigger mkdocs deployment on main

commit 897cc373ce4f9d18d8cb2837b5931c4b674c836b
Merge: 89da371 3b5a830
Author: Matthias Wild <40327258+mauwii@users.noreply.github.com>
Date:   Wed Sep 14 07:51:23 2022 +0200

    Merge pull request #1 from mauwii/mkdocs

    Mkdocs

commit 3b5a8308eb6b7ee572ff07f78829f64bcf55b4d9
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:42:56 2022 +0200

    huge update
    I was pretty busy trying to make the Readmes / docs  look good in MkDocs

commit 0b4f5a926ff8aad1460e0be8093ee02d719a576d
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:41:45 2022 +0200

    update mkdocs config

commit 872172ea7008aa1217c1259c7ecab16ddafd1a0e
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:33:49 2022 +0200

    added the mkdocs-git-revision-date-plugin

commit eac81bf87588ec88b65f3415aa838c330fbd621b
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 06:46:43 2022 +0200

    add  prettier config
    remove markdownlint
    move and rename requirements-mkdocs.txt

commit b36d4cc088a49af56026aa2dd2e85d6bfb181bd1
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 02:06:39 2022 +0200

    add dark theme

commit a14f18fede6febccf1c117cba50a1aff1eac80a9
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 01:38:02 2022 +0200

    update mkdocs flow and config

commit 2764b48693ed382bc01a2cb7aab282dbf95cd9ee
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 01:15:33 2022 +0200

    add mkdocs workflow

commit 1bd22523b1a52ac24bc5f950debb450f903c2d51
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 00:57:37 2022 +0200
    I already begun with formating /  revising the sites

* change repository in mkdocs config to lstein

* adapt changes from repos main README.md

Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-15 10:53:41 -04:00
Armando C. Santisbon
8a8c093795
Merge branch 'lstein:main' into main 2022-09-13 14:58:43 -05:00
Andre LaBranche
10c51b4f35
Minor cleanup and re-arranging of PATH docs (#533)
* slightly more consistent in how the different scenarios are described
* moved the stuff about `/usr/bin/python` to be adjacent to the stuff about `/usr/bin/python3`
* added an example of the 'option 1' goal state
* described a way to directly answer the question: how many snakes are living in your computer?
2022-09-13 15:13:47 -04:00
Armando C. Santisbon
0aa3dfbc35 Update link to guide on Docker, supported architectures, and platform specifiers. 2022-09-12 23:46:45 -05:00
Armando C. Santisbon
d4941ca833 Doc cleanup 2022-09-12 22:17:37 -05:00
Armando C. Santisbon
00b002f731 Move README-Docker to docs folder 2022-09-12 22:01:40 -05:00
Niek van der Maas
aba94b85e8 Fix macOS pyenv instructions, add code block highlight (#441)
Fix: `anaconda3-latest` does not work, specify the correct virtualenv, add missing init.
2022-09-11 22:34:39 -04:00
Lincoln Stein
4f72cb44ad moved the notebook files into their own directory 2022-09-11 13:05:38 -04:00
blessedcoolant
0881d429f2
Docs Update (#466)
Authored-by: @blessedcoolant 
Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-11 11:52:43 -04:00