mirror of
https://github.com/ublue-os/bazzite.git
synced 2025-01-16 16:10:58 +00:00
181497bc17
* feat: add mdbook docs * chore: add several articles to docs * docs: add documentation at surface level Using Discourse urls as fallback for missing content for now docs: add missing image files * docs: Add missing chapter emojis docs: Add missing warning in Advanced docs in summary docs: add missing waydroid guide docs: rename files to avoid spaces docs: fix badly set docs build params docs: remove unnecesary placeholders * docs: Realocate 'Gaming' section under 'General' * docs: Add 'Introduction' section This section contains a table of contents of the documentation * docs: Add unstable documentation warning * docs: Add missing github url docs: add missing symlink to resources * docs: Add discourse scrapper utility * docs: minor discourse scrapper docs changes * docs: Add youtube embeding preprocessor * minor reformat for youtube-embed * docs: Add mdbook preprocessor template * docs: add format-author preprocessor * docs: add git lib to mdbook toolset * docs: Always fetch the highest quality image by fetch_discourse_md * docs: fix youtube-embed ignoring new line requirement * docs: Add documentation transcription guide * docs: Missing url in transcription guide * docs: Remove YAML header from doc guide * docs: Minor tweaks to transcription guide * docs: Add utilities preprocessor module docs: Move debug preprocessor util to utils * docs: tweak debug function * docs: Add 'replace-urls' preprocessor * chore: Move mappings parameter in replace-urls preprocessor * docs: add ignore field to replace-urls * docs: add Mdbook python types * docs: Add ignore field to replace-urls Now we can exclude files from being processed with blob patterns * chore(ci): add deploy_docs * chore(ci): Add dynamic edit url template to deploy_docs * chore(ci): Add html.site-url to deploy_docs * chore(readme): Use relative paths for repo_content * chore(ci): Add README to included paths for deploy_docs * chore(ci): Disable deploy_docs * chore(ci): Use main in deploy_docs.on.push.branches * docs: Rephrase unstable docs warning * chore(ci): Exclude docs from triggering build workflow * chore(ci): Enable deploy_docs * fix(docs): Remove unnecessary imports in preprocessors * docs: Move unstable docs warning to index.hbs * docs: Add page metadata inclusion with fetch_discourse_md.py * docs: Move fetch_discourse_md.py to docs/utils * docs: Add 'fetched_at' metadata field in fetch_discourse_md.py * docs: Update fetch_discourse_md.py to format metadata in json * Revert "chore(readme): Use relative paths for repo_content" This reverts commit6a781c6596. * docs: Replace include with an url to repo README * ci(docs): Add multilanguage doc build support * docs: add Justfile utility * docs: update Justfile utility * ci(docs): Add stricter workflow trigger to deploy_docs * docs: add 'preview_translation' to Justfile * docs: add documentation translation guide * ci(docs): Add mdbook cache * ci(docs): Add i18n-report * ci(docs): tweak deploy_docs workflow triggers * ci(docs): remove unnecessary slash at build.yml * ci(docs): remove unnecessary slash at deploy_docs.yml * ci(docs): add docs/book.toml to deploy_docs trigger * ci(docs): Add schedule trigger * ci(docs): add github-pages cleaning * ci(docs): Exclude docs from generate_changelog * docs: Add dependencies installation script * ci(docs): Add mdbook pdf build * docs: Tweak Justfile to support pdf generation * Revert "docs: Always fetch the highest quality image by fetch_discourse_md" This reverts commit74130ee1fe. * ci(docs): Exclude deploy_docs.yml from cache-mdbook keys * docs: Add 'mdbook_build' to Justfile * docs: Add 'mdbook_serve' to Justfile * docs: Add debug flag to fetch_discourse_md * docs: Automate discourse documentation scrapping * docs: Add flock to fetch_discourse_md * docs: Add translation file generation with Justfile * docs: Prefix url replacements with site-url in replace-urls.py preprocessor * docs: Add installation guides docs: Replace print button * Revert "docs: Prefix url replacements with site-url in replace-urls.py preprocessor" This reverts commita685de4dce. * Reapply "docs: Prefix url replacements with site-url in replace-urls.py preprocessor" This reverts commit777d8055ea. * docs: fix replace-urls.py * docs: fix fetch_discourse_md.py hitting discourse ip_10_secs_limit * ci(docs): Remove duplicate '/' in build translation step * ci(docs): Update actions/cache * ci(docs): Reduce deploy_docs schedule timespan between triggers * docs: update install-deps.sh * docs: Update Advanced docs * docs: Add favicon * docs: Reword unstable documentation warning * docs: Change default theme to 'navy' * ci(docs): Move permisions to job scope
70 lines
1.8 KiB
Python
70 lines
1.8 KiB
Python
import datetime
|
|
import os
|
|
from pathlib import Path
|
|
from typing import Any, Optional
|
|
|
|
|
|
# Example mdBook context
|
|
example_ctx = {
|
|
"root": "/var/home/zeglius/Documentos/Github/bazzite_mdbook/docs",
|
|
"config": {
|
|
"book": {
|
|
"authors": ["nicknamenamenick", "Zeglius"],
|
|
"language": "en",
|
|
"multilingual": False,
|
|
"src": "src",
|
|
"title": "Bazzite Documentation",
|
|
},
|
|
"build": {
|
|
"build-dir": "book",
|
|
"create-missing": False,
|
|
"extra-watch-dirs": [],
|
|
"use-default-preprocessors": False,
|
|
},
|
|
"output": {
|
|
"html": {
|
|
"edit-url-template": "https://github.com/ublue-os/bazzite/edit/main/docs/{path}",
|
|
"git-repository-url": "https://github.com/ublue-os/bazzite",
|
|
}
|
|
},
|
|
"preprocessor": {
|
|
"links": {},
|
|
"youtube-embed": {"command": "python ./preprocessors/youtube-embed.py"},
|
|
},
|
|
},
|
|
"renderer": "html",
|
|
"mdbook_version": "0.4.40",
|
|
}
|
|
|
|
|
|
class Utils:
|
|
|
|
@staticmethod
|
|
def get_config_from_ctx(preprocessor_name: str, ctx: dict) -> Optional[dict]:
|
|
"""Get the config from mdBook context
|
|
|
|
Returns:
|
|
|
|
"""
|
|
ctx.get("")
|
|
return ctx["config"]["preprocessor"][preprocessor_name]
|
|
|
|
|
|
####################### DEBUG UTILS #######################
|
|
|
|
_DEBUG = os.getenv("DEBUG", "")
|
|
_DEBUG_OUTPUT = Path("./debug.txt")
|
|
|
|
|
|
def debug(*obj: object):
|
|
"""Dump info into a debug.txt if env var DEBUG=1"""
|
|
if _DEBUG in ["1", "yes"]:
|
|
with open(_DEBUG_OUTPUT, "+a") as stdout:
|
|
print(f"DEBUG[{datetime.date.today()}]:", *obj, file=stdout)
|
|
|
|
|
|
###########################################################
|
|
|
|
|
|
__all__ = ["Utils", "debug"]
|