Moving custom_theme dir down into the mkdocs dir

tpill90 · Feb 15, 2024 · f1c2ea2 · f1c2ea2
1 parent 48c98e7
commit f1c2ea2
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git 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 → docs/mkdocs/custom_theme/breadcrumbs.html b/docs/custom_theme/breadcrumbs.html → docs/mkdocs/custom_theme/breadcrumbs.html
diff --git a/docs/custom_theme/footer.html → docs/mkdocs/custom_theme/footer.html b/docs/custom_theme/footer.html → docs/mkdocs/custom_theme/footer.html
diff --git 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.
 
 -----