Experiment with the mkdocs offline plugin

In doing so, don't emphasise online docs over offline, but instead make this
about an online/offline split and both are as important as each other.
This commit is contained in:
Dave Pearson
2023-02-07 10:06:05 +00:00
parent aece00e1dc
commit a8aaa7ad82
5 changed files with 18 additions and 17 deletions

2
.gitignore vendored
View File

@@ -110,7 +110,7 @@ venv.bak/
# mkdocs documentation
/site
/docs-local
/docs-offline
# mypy
.mypy_cache/

View File

@@ -12,11 +12,11 @@ format-check:
black --check src
docs-serve:
rm -rf .screenshot_cache
mkdocs serve
mkdocs serve --config-file mkdocs-online.yml
docs-build:
mkdocs build
docs-local-build:
mkdocs build --config-file mkdocs-local.yml
mkdocs build --config-file mkdocs-online.yml
docs-build-offline:
mkdocs build --config-file mkdocs-offline.yml
docs-deploy:
rm -rf .screenshot_cache
mkdocs gh-deploy

View File

@@ -62,9 +62,9 @@ theme:
name: Switch to light mode
plugins:
- autorefs:
- mkdocstrings:
- search:
- autorefs:
- mkdocstrings:
custom_templates: docs/_templates
default_handler: python
handlers:
@@ -79,7 +79,7 @@ plugins:
- "!^can_replace$"
watch:
- src/textual
- exclude:
- exclude:
glob:
- "**/_template.md"

View File

@@ -1,7 +1,9 @@
INHERIT: mkdocs-common.yml
site_dir: docs-local
use_directory_urls: false
plugins:
- offline
site_dir: docs-offline
nav:
- Introduction:

View File

@@ -4,7 +4,6 @@ site_url: https://textual.textualize.io/
edit_uri: edit/main/docs/
plugins:
- search:
- blog:
- rss:
match_path: blog/posts/.*