From 2b4f391559586af734d5d5cb5886aa78c4f9557d Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 30 Aug 2018 19:36:22 +0200 Subject: [PATCH] add "noindex, nofollow" HTML robots meta-tag to documentation pages - Customize the "readthedocs" mkdocs theme: https://www.mkdocs.org/user-guide/styling-your-docs/#customizing-a-theme - Adds a '' HTML tag on each page - Do not include robots directive on readthedocs.org, only in local builds --- doc/custom_theme/main.html | 25 +++++++++++++++++++++++++ mkdocs.yml | 4 +++- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 doc/custom_theme/main.html diff --git a/doc/custom_theme/main.html b/doc/custom_theme/main.html new file mode 100644 index 0000000..69b398f --- /dev/null +++ b/doc/custom_theme/main.html @@ -0,0 +1,25 @@ +{% extends "base.html" %} + +{# +The entry point for the ReadTheDocs Theme. + +Any theme customisations should override this file to redefine blocks defined in +the various templates. The custom theme should only need to define a main.html +which `{% extends "base.html" %}` and defines various blocks which will replace +the blocks defined in base.html and its included child templates. +#} + +{%- block site_meta %} + + + + +{%- if 'media.readthedocs.org' not in config.extra_css[0] %} + +{%- endif %} + +{% if page and page.is_homepage %}{% endif %} +{% if config.site_author %}{% endif %} +{% if config.site_favicon %} +{% else %}{% endif %} +{%- endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 941fce3..248fdbf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,9 @@ site_name: Shaarli Documentation repo_url: https://github.com/shaarli/Shaarli edit_uri: edit/master/doc/md site_description: The personal, minimalist, super-fast, database free, bookmarking service -theme: readthedocs +theme: + name: readthedocs + custom_dir: doc/custom_theme/ docs_dir: doc/md site_dir: doc/html # Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings: