git » chasquid » commit a7d4979

docs: Self-host the documentation

author Alberto Bertogli
2019-08-06 23:53:59 UTC
committer Alberto Bertogli
2019-08-06 23:59:45 UTC
parent c6c9866ae1c0dcf77de25a34e32a71f297c6ac3a
docs: Self-host the documentation

Instead of use readthedocs.org, point to the self-hosted version of the
rendered documentation.

We still use mkdocs to generate it, it's just more practical and
consistent to self-host the documentation.
.readthedocs.yml +0 -8
README.md +2 -3 
diff --git a/.readthedocs.yml b/.readthedocs.yml
deleted file mode 100644
index 2cfa631..0000000
--- a/.readthedocs.yml
+++ /dev/null
@@ -1,8 +0,0 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details.
-version: 2
-
-mkdocs:
-  configuration: .mkdocs.yml
-
-
diff --git a/README.md b/README.md
index e86f1df..5bd63c7 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,6 @@ It's written in [Go](https://golang.org), and distributed under the
 [![Go Report Card](https://goreportcard.com/badge/github.com/albertito/chasquid)](https://goreportcard.com/report/github.com/albertito/chasquid)
 [![Coverage Status](https://coveralls.io/repos/github/albertito/chasquid/badge.svg?branch=next)](https://coveralls.io/github/albertito/chasquid?branch=next)
 [![GoDoc](https://godoc.org/blitiri.com.ar/go/chasquid?status.svg)](https://godoc.org/blitiri.com.ar/go/chasquid)
-[![Documentation Status](https://readthedocs.org/projects/chasquid/badge/?version=latest)](https://chasquid.readthedocs.io/en/latest/?badge=latest)
 [![Freenode](https://img.shields.io/badge/chat-freenode-brightgreen.svg)](https://webchat.freenode.net?channels=%23chasquid)
 
 
@@ -49,7 +48,7 @@ It's written in [Go](https://golang.org), and distributed under the
 [MTA-STS]: https://tools.ietf.org/html/rfc8461
 [Debian]: https://debian.org
 [Ubuntu]: https://ubuntu.com
-[Tracking]: https://chasquid.readthedocs.io/en/latest/sec-levels/
+[Tracking]: https://blitiri.com.ar/p/chasquid/docs/sec-levels/
 
 
 ## Documentation
@@ -58,7 +57,7 @@ The [how-to guide](docs/howto.md) and the [installation
 guide](docs/install.md) are the best starting points on how to install,
 configure and run chasquid.
 
-You will find [all documentation here](https://chasquid.readthedocs.io).
+You will find [all documentation here](https://blitiri.com.ar/p/chasquid/docs/).
 
 
 ## Contact