From f1c2ea2d58b9542e1b92e9f0f5fc35565495f558 Mon Sep 17 00:00:00 2001 From: Tim Pilius Date: Wed, 14 Feb 2024 23:17:26 -0500 Subject: [PATCH] Moving custom_theme dir down into the mkdocs dir --- docs/mkdocs.yml | 6 ++++-- docs/{ => mkdocs}/custom_theme/breadcrumbs.html | 0 docs/{ => mkdocs}/custom_theme/footer.html | 0 docs/mkdocs/dev-guides/mkdocs-setup.md | 2 ++ 4 files changed, 6 insertions(+), 2 deletions(-) rename docs/{ => mkdocs}/custom_theme/breadcrumbs.html (100%) rename docs/{ => mkdocs}/custom_theme/footer.html (100%) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index fe804734..741c154d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -27,8 +27,10 @@ extra: theme: name: readthedocs - # For defaults see : https://github.com/mkdocs/mkdocs/tree/master/mkdocs/themes/readthedocs - custom_dir: custom_theme/ + # Customized header (removes Edit on Github link) and customized footer (removes Built with mkdocs text) + # For the defaults see : https://github.com/mkdocs/mkdocs/tree/master/mkdocs/themes/readthedocs + custom_dir: mkdocs/custom_theme/ + #TODO fix the code highlighting theme. Looks crappy highlightjs: true # Examples of themes - https://highlightjs.org/static/demo/ # Find which themese are available on the cdn - https://cdnjs.com/libraries/highlight.js diff --git a/docs/custom_theme/breadcrumbs.html b/docs/mkdocs/custom_theme/breadcrumbs.html similarity index 100% rename from docs/custom_theme/breadcrumbs.html rename to docs/mkdocs/custom_theme/breadcrumbs.html diff --git a/docs/custom_theme/footer.html b/docs/mkdocs/custom_theme/footer.html similarity index 100% rename from docs/custom_theme/footer.html rename to docs/mkdocs/custom_theme/footer.html diff --git a/docs/mkdocs/dev-guides/mkdocs-setup.md b/docs/mkdocs/dev-guides/mkdocs-setup.md index 917d3d1f..dd1322ee 100644 --- a/docs/mkdocs/dev-guides/mkdocs-setup.md +++ b/docs/mkdocs/dev-guides/mkdocs-setup.md @@ -19,6 +19,8 @@ pip install -r requirements.txt mkdocs.yml # Mkdocs root configuration file. mkdocs/ index.md # The documentation homepage. + assets/ # Contains custom Javascript and CSS used on the docs site + custom_theme ... # Other markdown pages, images and other files. -----