From f0b89e5622a86e191478b5c5bf32891904b9c190 Mon Sep 17 00:00:00 2001 From: Marc Gilleron Date: Fri, 22 Jan 2021 18:47:43 +0000 Subject: [PATCH] Make more space --- doc/source/___.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/doc/source/___.md b/doc/source/___.md index 385dd0eb..f5861f7c 100644 --- a/doc/source/___.md +++ b/doc/source/___.md @@ -1,11 +1,8 @@ Nothing to see here. -This file is an expression of my lack of motivation to make Mkdocs work better with ReadTheDocs. It sits there only to separate a bit more the API section from the rest of the doc. +Have a Capybara. -The API class list is at "top level" (actually second level) and does not fold, because no more than 2 file-levels are supported by the theme provided by ReadTheDocs. If the class files were placed at third level, folding works for them, but breaks the rest of the nav. +![Capybara image](https://upload.wikimedia.org/wikipedia/commons/thumb/e/ec/Capybara_%28Hydrochoerus_hydrochaeris%29.JPG/220px-Capybara_%28Hydrochoerus_hydrochaeris%29.JPG) -Allowing custom themes on ReadTheDocs could allow to fix it, but it's [officially not supported](https://github.com/readthedocs/readthedocs.org/issues/978#issuecomment-285212453). -I considered switching to Sphinx, but it's too complicated in comparison to Mkdocs. Switching all the existing docs and scripts to use ReStructuredText is also a lot of work. Sphinx claims to support Markdown too but my attempts at using it failed. - -So for now... have a bit of space. +*Photo by [Charles James Sharp](https://www.wikidata.org/wiki/Q54800218) - CC-BY-SA*