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:
parent
aece00e1dc
commit
a8aaa7ad82
5 changed files with 18 additions and 17 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -110,7 +110,7 @@ venv.bak/
|
|||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
/docs-local
|
||||
/docs-offline
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
|
|
|
|||
8
Makefile
8
Makefile
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -62,12 +62,12 @@ theme:
|
|||
name: Switch to light mode
|
||||
|
||||
plugins:
|
||||
|
||||
- autorefs:
|
||||
- mkdocstrings:
|
||||
custom_templates: docs/_templates
|
||||
default_handler: python
|
||||
handlers:
|
||||
- search:
|
||||
- autorefs:
|
||||
- mkdocstrings:
|
||||
custom_templates: docs/_templates
|
||||
default_handler: python
|
||||
handlers:
|
||||
python:
|
||||
options:
|
||||
show_root_heading: true
|
||||
|
|
@ -79,9 +79,9 @@ plugins:
|
|||
- "!^can_replace$"
|
||||
watch:
|
||||
- src/textual
|
||||
- exclude:
|
||||
glob:
|
||||
- "**/_template.md"
|
||||
- exclude:
|
||||
glob:
|
||||
- "**/_template.md"
|
||||
|
||||
|
||||
extra_css:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
INHERIT: mkdocs-common.yml
|
||||
|
||||
site_dir: docs-local
|
||||
use_directory_urls: false
|
||||
plugins:
|
||||
- offline
|
||||
|
||||
site_dir: docs-offline
|
||||
|
||||
nav:
|
||||
- Introduction:
|
||||
|
|
@ -4,7 +4,6 @@ site_url: https://textual.textualize.io/
|
|||
edit_uri: edit/main/docs/
|
||||
|
||||
plugins:
|
||||
- search:
|
||||
- blog:
|
||||
- rss:
|
||||
match_path: blog/posts/.*
|
||||
Loading…
Reference in a new issue