From e453c3b0fa116d729895b61f37d363bfede55d1a Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 10 May 2021 09:44:11 +0100 Subject: Setup; add book.toml We seem to include the documentation in our packaging, so perhaps we should include book.toml as well? --- MANIFEST.in | 1 + book.toml | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 book.toml diff --git a/MANIFEST.in b/MANIFEST.in index 25d1cb758e..0522319c40 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -40,6 +40,7 @@ exclude mypy.ini exclude sytest-blacklist exclude test_postgresql.sh +include book.toml include pyproject.toml recursive-include changelog.d * diff --git a/book.toml b/book.toml new file mode 100644 index 0000000000..aefcb6a5bd --- /dev/null +++ b/book.toml @@ -0,0 +1,26 @@ +# Documentation for possible options in this file is at +# https://rust-lang.github.io/mdBook/format/config.html +[book] +title = "Synapse" +authors = ["The Matrix.org Foundation C.I.C."] +language = "en" +multilingual = false + +# The directory that documentation files are stored in +src = "docs" + +[build] +# Prevent markdown pages from being automatically generated when they're +# linked to in SUMMARY.md +create-missing = false + +[output.html] +# The URL visitors will be directed to when they try to edit a page +# Disabled until https://github.com/rust-lang/mdBook/issues/1543 is fixed +#edit-url-template = "https://github.com/matrix-org/synapse/edit/develop/{path}" + +# The source code URL of the repository +git-repository-url = "https://github.com/matrix-org/synapse" + +# The path that the docs are hosted on +site-url = "/synapse/" \ No newline at end of file -- cgit 1.5.1