1
0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-16 14:27:01 +00:00

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.
This commit is contained in:
Alberto Bertogli
2019-08-07 00:53:59 +01:00
parent c6c9866ae1
commit a7d49792f5
2 changed files with 2 additions and 11 deletions

View File

@@ -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

View File

@@ -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