GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — python-scraperlib/mkdocs.yml at main · cking100/python-scraperlib

Expand file tree

/

mkdocs.yml

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
92 lines (82 loc) · 2.57 KB
/

mkdocs.yml

Copy path

File metadata and controls

92 lines (82 loc) · 2.57 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
site_name: Python Scraperlib
site_description: 'Collection of Python code to re-use across Python-based OpenZIM scrapers.'
repo_url: https://github.com/openzim/python-scraperlib
repo_name: GitHub
edit_uri: edit/main/docs/
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
nav:
- Home: index.md
- Design:
- Functional Architecture: functional_architecture.md
- Software Architecture: software_architecture.md
- Technical Architecture: technical_architecture.md
- API Reference: api_reference/
- License: license.md
theme:
name: material
logo: assets/openzim.png
palette:
# Light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
# Use XHR for page changes to avoid page flash during navigation.
- navigation.instant
- navigation.instant.progress
# Use tabs and section headers rather than a single side navbar.
- navigation.tabs
- navigation.sections
# Add buttons to edit content
- content.action.edit
markdown_extensions:
- pymdownx.snippets:
base_path: .
check_paths: true
plugins:
- search
# Replace externally hosted assets for compliance with various privacy regulations.
- privacy
# Nicely include markdown, e.g. to rewrite relative links
- include-markdown
# Generate API docs and navigation for them
- gen-files:
scripts:
- docs/scripts/generate_api_nav.py
# Import additional nav from NAVIGATION.md files, like the one produced
# by gen-files.
- literate-nav:
nav_file: NAVIGATION.md
# Generate items
- mkdocstrings:
handlers:
python:
# Set up cross-references to Python types
import:
- https://docs.python.org/3/objects.inv
paths: [src]
options:
docstring_section_style: list
filters: ['!^_']
heading_level: 2
inherited_members: true
merge_init_into_class: true
separate_signature: true
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
# Typically this should be off, but zimscraperlib has many
# items that won't be picked up because they lack docs
# or are using single line comments (like constants).
show_if_no_docstring: true
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.