File: configure-mkdocs-for-debian

package info (click to toggle)
python-guizero 1.6.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,872 kB
  • sloc: python: 7,160; makefile: 34; sh: 17
file content (39 lines) | stat: -rw-r--r-- 1,095 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Description: configure mkdocs build for Debian systems
 Based on similar patches for projectile and python-markdown with
 some specific changes for python-guizero
 .
 1. set use_directory_urls to false so that links are to foo/index.html
    rather than to foo/, which is better for offline browsing
 .
 2. don't generate installation, development and deployment pages
 .
 3. remove nav item for about.md, which we use to replace index.md
 .
 4. use nature theme instead of litera theme
 .
Author: Nick Morrott <nickm@debian.org>
Forwarded: not-needed
Last-Update: 2025-02-02
---
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,10 +1,9 @@
 site_name: guizero
 theme:
-  name: 'litera'
+  name: 'nature'
 extra_css: [extra.css]
+use_directory_urls: false
 nav:
-  - About: about.md
-  - Installation: index.md
   - Using guizero:
       - Getting started: start.md
       - Using Widgets: usingwidgets.md
@@ -41,6 +40,4 @@
   - Book : book.md
   - Contributing:
       - Notes: contributing.md
-      - Developing: development.md
-      - Deploying: deployment.md
   - Change log: changelog.md