Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ extra:
min_python_version_tag: "310" # The tag version of the minimum python version
recent_python_version: "3.13" # The newest Python version known to work on all platforms
docs_python_version: "3.13" # The version of Python required to build the documentation
translated: false # true hides content related to building translations. Default: false.
translated: true # false hides content related to building translations. Default: false.
hide_coverage: false # true hides content related to code coverage. Default: false.
macos_only: false # true hides tabbed content, and displays only macOS instructions. Default: false.
alternate:
Expand Down Expand Up @@ -53,6 +53,8 @@ theme:
- toc.follow
- navigation.indexes
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- search.suggest
- search.highlight
- search.share
Expand Down
8 changes: 4 additions & 4 deletions docs/en/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
- BeeWare Docs Tools Demo section one
- [BeeWare Docs Tools Demo section one](section_one/index.md)
- Section one
- [Section one](section_one/index.md)
- [Section one - page two](section_one/page_two.md)
- [Section two](section_two/index.md)
- [Section three](section_three/index.md)
- ./section_three/*
- Shared content test bed
- [Shared content test bed](content_test_bed/index.md)
- Shared content testbed
- [Shared content testbed](content_test_bed/index.md)
- How-to guides
- Contribute
- [Contributing](content_test_bed/how-to/contribute/index.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BeeWare Docs Tools Demo
# Docs Tools Demo

## Theme checklist

Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ subdirectories
subdirectory
symlinked
symlinking
testbed
Titlebar
titlebar
Triaging
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ dependencies = [
"mkdocs-autorefs==1.4.3",
"mkdocs-literate-nav==0.6.2",
"mkdocs-macros-plugin==1.5.0",
"mkdocs-material==9.7.0",
"mkdocs-material==9.7.1",
"mkdocs==1.6.1",
"mkdocstrings-python==2.0.1",
"pymdown-extensions==10.19.1",
Expand Down
6 changes: 5 additions & 1 deletion src/beeware_docs_tools/live_serve_en.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ def parse_args() -> Namespace:
parser.add_argument("watch_directories", nargs="*")
parser.add_argument("--strict", action="store_true")
parser.add_argument("--source-code", action="append")
parser.add_argument("--port", type=int, default=8037)
args = parser.parse_args()

return args
Expand All @@ -29,6 +30,7 @@ def serve_docs(
output_path: Path,
strict: bool,
watch_directories: list[str],
port: int,
) -> None:
serve_command = [
"python",
Expand All @@ -40,6 +42,8 @@ def serve_docs(
str(output_path / "mkdocs.en.yml"),
"--watch",
"docs",
"--dev-addr",
f"localhost:{port}",
]

if strict:
Expand Down Expand Up @@ -69,7 +73,7 @@ def main():
target_is_directory=True,
)

serve_docs(temp_md_path, args.strict, args.watch_directories)
serve_docs(temp_md_path, args.strict, args.watch_directories, args.port)


if __name__ == "__main__":
Expand Down
8 changes: 4 additions & 4 deletions src/beeware_docs_tools/overrides/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
<body>
<h1 style="font-family:Cutive;padding:1rem;">404: Page not found</h1>
<div class="not-found-bees" style="padding:1rem;">
<img src="assets/images/bumble.png" alt="Brutus the bee flying along with a dashed trail behind him" />
</div>
<div class="not-found-bees" style="padding:1rem;">
<img src="assets/images/bumble-small.png" alt="Brutus the bee flying along with a dashed trail behind him" />
<!-- <img src="assets/images/bumble.png" alt="Brutus the bee flying along with a dashed trail behind him" />-->
<!-- </div>-->
<!-- <div class="not-found-bees" style="padding:1rem;">-->
<!-- <img src="assets/images/bumble-small.png" alt="Brutus the bee flying along with a dashed trail behind him" />-->
</div>
<div id="not-found-text" style="font-family:Cutive;padding:1rem;">
<h2>Brutus can't find what you're looking for</h2>
Expand Down
Loading