From b56507dc3fad4522b15cb0a7095f2a87efa72e2e Mon Sep 17 00:00:00 2001 From: Andrew Pikul Date: Thu, 26 Dec 2024 15:48:59 -0500 Subject: [PATCH] Rebuild docs --- pyproject.toml | 2 +- site/404.html | 49 +----- site/TECH_NOTE/index.html | 49 +----- site/api/logistro/index.html | 329 +++++++++++++++++++++++++++++------ site/index.html | 55 +----- site/sitemap.xml | 6 +- site/sitemap.xml.gz | Bin 218 -> 218 bytes uv.lock | 3 +- 8 files changed, 283 insertions(+), 210 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 594695a..a209aaa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,7 +33,7 @@ dev = [ "pytest>=8.3.4", ] docs = [ - "mkquixote @ git+ssh://git@github.com/geopozo/mkquixote", +# "mkquixote @ git+ssh://git@github.com/geopozo/mkquixote", "mkdocs>=1.6.1", "mkdocs-material>=9.5.49", ] diff --git a/site/404.html b/site/404.html index d35919a..500638f 100644 --- a/site/404.html +++ b/site/404.html @@ -212,51 +212,12 @@ - - - - - - - - -
  • - - - - - - - - - - -
    • - - diff --git a/site/TECH_NOTE/index.html b/site/TECH_NOTE/index.html index 6d6f0d4..9d2692e 100644 --- a/site/TECH_NOTE/index.html +++ b/site/TECH_NOTE/index.html @@ -281,51 +281,12 @@ - - - - - - - - -
  • - - - - - - - - - - -
    • - - diff --git a/site/api/logistro/index.html b/site/api/logistro/index.html index 41a4aaf..62faef8 100644 --- a/site/api/logistro/index.html +++ b/site/api/logistro/index.html @@ -22,7 +22,7 @@ - logistro - logistro + Reference - logistro @@ -102,7 +102,7 @@
    - logistro + Reference
    @@ -223,72 +223,164 @@ - - +
  • - + - - - -
  • - - - + + + + + - +
    • @@ -314,6 +406,125 @@ + + + @@ -333,19 +544,23 @@

    package: logistro

    Logistro wraps logging for added defaults and subprocess logging.

    Typical usage:

    -

    import logistro -logger = logistro.getLogger(name) -logger.debug2("This will be printed more informatively")

    -

    Advanced

    -

    pipe, logger = logistro.getPipeLogger(name)

    -

    Pipe all stderr to our logger

    -

    subprocess.Popen(process_name, stderr=pipe)

    -

    subprocess.wait() -os.close(pipe)

    -

    Attributes

    +
    import logistro
+logger = logistro.getLogger(__name__)
+logger.debug2("This will be printed more informatively")
+
+# Advanced
+pipe, logger = logistro.getPipeLogger(__name__)
+# Pipe all stderr to our logger
+subprocess.Popen(process_name, stderr=pipe)
+
+# Eventually close the pipe in case other process doesn't
+subprocess.wait()
+os.close(pipe)
+
    +

    Globals

    DEBUG2 - A more verbose version of logging.DEBUG
    -
    human_formatter -
    -
    structured_formatter -
    +
    human_formatter - A logging.Formatter() to print output nicely.
    +
    structured_formatter - A logging.Formatter() to print output as JSON for machine consumption.

    Functions

    betterConfig(kwargs)
    diff --git a/site/index.html b/site/index.html index fa4bbbf..b9f16bb 100644 --- a/site/index.html +++ b/site/index.html @@ -249,7 +249,7 @@
  • - Functions: + Functions @@ -312,51 +312,12 @@ - - - - - - - - -
  • - - - - - - - - - - -
    • - - @@ -421,7 +374,7 @@
  • - Functions: + Functions @@ -494,7 +447,7 @@

    CLI Flags

  • --logistro-human (default)
  • --logistro-structured which outputs JSON
    • -

    Functions:

    +

    Functions