From 5d2a556bb80c241f5cff4da9c70c166dfc0dc3ec Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Mon, 14 Sep 2020 21:39:00 +0200 Subject: [PATCH] migrate the doc to rtd --- CONTRIBUTING.md | 4 ++-- README.md | 26 +++++++++++++------------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b0613c..e79be9b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,7 +127,7 @@ potential *included* entries * profile's *include Variables are then used to resolve different elements in the config file: -see [this](https://github.com/deadc0de6/dotdrop/wiki/config-variables#config-available-variables) +see [this](docs/config.md#variables) ## rules @@ -185,4 +185,4 @@ start of your new test (see the head of the file down to `# this is the test`). # documentation -Most of dotdrop documentation is hosted in [its wiki](https://github.com/deadc0de6/dotdrop/wiki) +Dotdrop documentation is available under [https://dotdrop.readthedocs.io/](https://dotdrop.readthedocs.io/). diff --git a/README.md b/README.md index 0d58b98..2650a4d 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,8 @@ Features: * Provide solutions for handling dotfiles containing sensitive information Check also the [blog post](https://deadc0de.re/articles/dotfiles.html), -the [example](#getting-started), the [wiki](https://github.com/deadc0de6/dotdrop/wiki) or -how [people are using dotdrop](https://github.com/deadc0de6/dotdrop/wiki/meta-people-using-dotdrop) +the [example](#getting-started), the [documentation](https://dotdrop.readthedocs.io/) or +how [people are using dotdrop](https://dotdrop.readthedocs.io/en/latest/misc/people-using-dotdrop/) for more. Quick start: @@ -83,7 +83,7 @@ you are cloning your dotfiles git tree from you'll have dotdrop shipped with it. Below instructions show how to install dotdrop as a submodule. For alternative installation instructions (with virtualenv, pypi, aur, snap, etc) see the -[wiki installation page](https://github.com/deadc0de6/dotdrop/wiki/installation). +[installation documentation](https://dotdrop.readthedocs.io/en/latest/installation/). Dotdrop is also available on * pypi: https://pypi.org/project/dotdrop/ @@ -130,7 +130,7 @@ Completion scripts exist for `bash`, `zsh` and `fish`, see [the related doc](com Create a new repository to store your dotfiles with dotdrop. *Init* or *clone* that new repository and -[install dotdrop](https://github.com/deadc0de6/dotdrop/wiki/installation#as-a-submodule). +[install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation/#as-a-submodule). Then import any dotfiles (files or directories) you want to manage with dotdrop. You can either use the default profile (which resolves to the *hostname* of the host @@ -178,7 +178,7 @@ profiles: - d_polybar ``` For a description of the different fields and their use, -see the [config doc](https://github.com/deadc0de6/dotdrop/wiki/config). +see the [config doc](https://dotdrop.readthedocs.io/en/latest/config-format/). Commit and push your changes. @@ -207,7 +207,7 @@ profiles: - d_polybar ``` -Then adapt any dotfile using the [templating](https://github.com/deadc0de6/dotdrop/wiki/templating) +Then adapt any dotfile using the [templating](https://dotdrop.readthedocs.io/en/latest/templating/) feature (if needed). For example you might want different fonts sizes on polybar for the different hosts: @@ -263,17 +263,17 @@ That's it, a single repository with all your dotfiles for your different hosts. You can then -* [create actions](https://github.com/deadc0de6/dotdrop/wiki/config-actions) -* [use transformations](https://github.com/deadc0de6/dotdrop/wiki/config-transformations) -* [use variables](https://github.com/deadc0de6/dotdrop/wiki/config-variables) -* [symlink dotfiles](https://github.com/deadc0de6/dotdrop/wiki/symlinked-dotfiles) -* [and more](https://github.com/deadc0de6/dotdrop/wiki) +* [create actions](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-actions) +* [use transformations](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-transformations) +* [use variables](https://dotdrop.readthedocs.io/en/latest/config/#variables) +* [symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/config/#symlink-dotfiles) +* [and more](https://dotdrop.readthedocs.io) -For more options see `dotdrop --help` and the [wiki](https://github.com/deadc0de6/dotdrop/wiki). +For more options see `dotdrop --help` and the [documentation](https://dotdrop.readthedocs.io). # Documentation -Dotdrop's documentation is hosted on [its wiki](https://github.com/deadc0de6/dotdrop/wiki). +Dotdrop's documentation is hosted on [readthedocs](https://dotdrop.readthedocs.io/en/latest/). # Thank you