mkdocs-owl-api 0.1.0__tar.gz

mkdocs_owl_api-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: Sync dependencies
+        run: uv sync
+      - name: Run tests
+        run: uv run pytest
+
+  example-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Sync dependencies
+        run: uv sync
+      - name: Build example site
+        run: uv run mkdocs build -f example/mkdocs.yml

mkdocs_owl_api-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Build distributions
+        run: uv build
+      - name: Validate metadata
+        run: uvx twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/mkdocs-owl-api/
+    permissions:
+      # OIDC token for Trusted Publishing; no API token in repo secrets.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

mkdocs_owl_api-0.1.0/.gitignore

@@ -0,0 +1,227 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+example/site/
+
+# generated by mkdocs-owl-api at build time (resolved specs + attachments)
+example/docs/assets/techdocs-owl-api/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local scratch notes/tasks (not part of the published project)
+.tasks/
+.claude/
+CLAUDE.md

mkdocs_owl_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TechDocs Owl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs_owl_api-0.1.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: mkdocs-owl-api
+Version: 0.1.0
+Summary: MkDocs plugin from TechDocs Owl, renders AsyncAPI and OpenAPI specs into reference pages
+Project-URL: Homepage, https://github.com/techdocs-owl/mkdocs-owl-api
+Project-URL: Repository, https://github.com/techdocs-owl/mkdocs-owl-api
+Project-URL: Issues, https://github.com/techdocs-owl/mkdocs-owl-api/issues
+Author-email: Dima Patserkovskyi <dmtwngtech@pm.me>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-reference,asyncapi,documentation,mkdocs,mkdocs-plugin,openapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: MkDocs
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.9
+Requires-Dist: markdown>=3.4
+Requires-Dist: mkdocs>=1.5
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# techdocs-owl-api
+
+MkDocs plugin that renders AsyncAPI and OpenAPI specs into reference pages
+at build time.
+
+## Install
+
+```bash
+pip install mkdocs-owl-api
+```
+
+```yaml
+# mkdocs.yml
+plugins:
+  - search
+  - owl-api
+```
+
+Add a page with a `techdocs-owl-asyncapi:` or `techdocs-owl-openapi:`
+frontmatter key and an empty body — the plugin fills it in at build time.
+
+```markdown
+---
+techdocs-owl-asyncapi: ../specs/asyncapi.yml
+---
+```
+
+Supports AsyncAPI 2.x/3.0 and OpenAPI 3.x (YAML or JSON), local paths or
+HTTP(S) URLs, recursive `$ref` resolution, and a bundled stylesheet
+(auto-injected, no `extra_css` setup needed).
+
+## Site-wide defaults
+
+```yaml
+plugins:
+  - owl-api:
+      schema_depth: 3
+      hide_internal: false
+      hide_bindings: false
+      hide_traits: false
+      hide_security: false
+      hide_version: false
+      hide_download_link: false
+```
+
+Page frontmatter overrides these per-page.
+
+## AsyncAPI pages
+
+```markdown
+---
+techdocs-owl-asyncapi:
+  spec: https://schema.example.com/my-service-asyncapi
+  title: My Service Events
+  intro: One-paragraph intro shown above the spec body.
+  schema_depth: 3
+---
+```
+
+| Key | Type | Default | Effect |
+|---|---|---|---|
+| `spec` | string | — | **Required.** Path or URL to the spec file. |
+| `title` | string | `info.title` | Page H1. |
+| `intro` | markdown | — | Shown between the title and metadata block. |
+| `hide_version` | bool | `false` | Hide the version line. |
+| `hide_internal` | bool | `false` | Drop properties marked `x-internal-only: true`. |
+| `hide_bindings` | bool | `false` | Skip bindings on servers/channels/operations/messages. |
+| `hide_traits` | bool | `false` | Skip trait sections and references. |
+| `hide_security` | bool | `false` | Skip security admonitions. |
+| `hide_download_link` | bool | `false` | Hide the spec download link. |
+| `schema_depth` | int | `3` | Depth of dot-path flattening for nested object properties. |
+| `attachments` | list | — | Extra files to copy and list in the downloads table. |
+
+Renders, in order: info, Servers, Operations (operation-centric across
+both AsyncAPI versions), Messages, Schemas, Parameters, Traits — sections
+absent from the spec are skipped.
+
+## OpenAPI pages
+
+```markdown
+---
+techdocs-owl-openapi: https://petstore3.swagger.io/api/v3/openapi.json
+---
+```
+
+| Key | Type | Default | Effect |
+|---|---|---|---|
+| `spec` | string | — | **Required.** Path or URL to the spec file. |
+| `title` | string | `info.title` | Page H1. |
+| `intro` | markdown | — | Shown between the title and metadata block. |
+| `hide_version` | bool | `false` | Hide the version line. |
+| `hide_internal` | bool | `false` | Drop `x-internal-only` properties. |
+| `hide_download_link` | bool | `false` | Hide the spec download link. |
+| `schema_depth` | int | `3` | Depth of dot-path flattening for nested object properties. |
+| `attachments` | list | — | Extra files to copy and list in the downloads table. |
+
+Renders: info, Servers, endpoints grouped by tag (parameters, request
+body, responses, security), Schemas.
+
+## Downloads & attachments
+
+The resolved spec (external `$ref`s inlined) is written to
+`assets/techdocs-owl-api/<page-slug>.json` and linked from a Downloads
+table. Add extra files (e.g. `.proto` schemas) with `attachments`:
+
+```markdown
+---
+techdocs-owl-asyncapi:
+  spec: ../specs/asyncapi.yml
+  attachments:
+    - path: ../schemas/customer.proto
+      title: Customer Protobuf Schema
+    - ../schemas/order.proto   # shorthand: path only, title = filename
+---
+```
+
+## Error handling
+
+Errors (missing/unreadable spec, network failures, parse errors, bad
+frontmatter) render as a `!!! danger` admonition instead of failing the
+build.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+```

mkdocs_owl_api-0.1.0/README.md

@@ -0,0 +1,128 @@
+# techdocs-owl-api
+
+MkDocs plugin that renders AsyncAPI and OpenAPI specs into reference pages
+at build time.
+
+## Install
+
+```bash
+pip install mkdocs-owl-api
+```
+
+```yaml
+# mkdocs.yml
+plugins:
+  - search
+  - owl-api
+```
+
+Add a page with a `techdocs-owl-asyncapi:` or `techdocs-owl-openapi:`
+frontmatter key and an empty body — the plugin fills it in at build time.
+
+```markdown
+---
+techdocs-owl-asyncapi: ../specs/asyncapi.yml
+---
+```
+
+Supports AsyncAPI 2.x/3.0 and OpenAPI 3.x (YAML or JSON), local paths or
+HTTP(S) URLs, recursive `$ref` resolution, and a bundled stylesheet
+(auto-injected, no `extra_css` setup needed).
+
+## Site-wide defaults
+
+```yaml
+plugins:
+  - owl-api:
+      schema_depth: 3
+      hide_internal: false
+      hide_bindings: false
+      hide_traits: false
+      hide_security: false
+      hide_version: false
+      hide_download_link: false
+```
+
+Page frontmatter overrides these per-page.
+
+## AsyncAPI pages
+
+```markdown
+---
+techdocs-owl-asyncapi:
+  spec: https://schema.example.com/my-service-asyncapi
+  title: My Service Events
+  intro: One-paragraph intro shown above the spec body.
+  schema_depth: 3
+---
+```
+
+| Key | Type | Default | Effect |
+|---|---|---|---|
+| `spec` | string | — | **Required.** Path or URL to the spec file. |
+| `title` | string | `info.title` | Page H1. |
+| `intro` | markdown | — | Shown between the title and metadata block. |
+| `hide_version` | bool | `false` | Hide the version line. |
+| `hide_internal` | bool | `false` | Drop properties marked `x-internal-only: true`. |
+| `hide_bindings` | bool | `false` | Skip bindings on servers/channels/operations/messages. |
+| `hide_traits` | bool | `false` | Skip trait sections and references. |
+| `hide_security` | bool | `false` | Skip security admonitions. |
+| `hide_download_link` | bool | `false` | Hide the spec download link. |
+| `schema_depth` | int | `3` | Depth of dot-path flattening for nested object properties. |
+| `attachments` | list | — | Extra files to copy and list in the downloads table. |
+
+Renders, in order: info, Servers, Operations (operation-centric across
+both AsyncAPI versions), Messages, Schemas, Parameters, Traits — sections
+absent from the spec are skipped.
+
+## OpenAPI pages
+
+```markdown
+---
+techdocs-owl-openapi: https://petstore3.swagger.io/api/v3/openapi.json
+---
+```
+
+| Key | Type | Default | Effect |
+|---|---|---|---|
+| `spec` | string | — | **Required.** Path or URL to the spec file. |
+| `title` | string | `info.title` | Page H1. |
+| `intro` | markdown | — | Shown between the title and metadata block. |
+| `hide_version` | bool | `false` | Hide the version line. |
+| `hide_internal` | bool | `false` | Drop `x-internal-only` properties. |
+| `hide_download_link` | bool | `false` | Hide the spec download link. |
+| `schema_depth` | int | `3` | Depth of dot-path flattening for nested object properties. |
+| `attachments` | list | — | Extra files to copy and list in the downloads table. |
+
+Renders: info, Servers, endpoints grouped by tag (parameters, request
+body, responses, security), Schemas.
+
+## Downloads & attachments
+
+The resolved spec (external `$ref`s inlined) is written to
+`assets/techdocs-owl-api/<page-slug>.json` and linked from a Downloads
+table. Add extra files (e.g. `.proto` schemas) with `attachments`:
+
+```markdown
+---
+techdocs-owl-asyncapi:
+  spec: ../specs/asyncapi.yml
+  attachments:
+    - path: ../schemas/customer.proto
+      title: Customer Protobuf Schema
+    - ../schemas/order.proto   # shorthand: path only, title = filename
+---
+```
+
+## Error handling
+
+Errors (missing/unreadable spec, network failures, parse errors, bad
+frontmatter) render as a `!!! danger` admonition instead of failing the
+build.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+```

mkdocs_owl_api-0.1.0/example/README.md

@@ -0,0 +1,15 @@
+
+## Example site
+
+Run from root directory:
+
+```bash
+uv sync
+uv run pytest
+```
+
+Run example demo site from `example` directory
+
+```bash
+uv run --project .. mkdocs serve
+```

mkdocs_owl_api-0.1.0/example/docs/api/petstore.md

@@ -0,0 +1,4 @@
+---
+techdocs-owl-openapi:
+  spec: https://petstore3.swagger.io/api/v3/openapi.json
+---

mkdocs_owl_api-0.1.0/example/docs/api/streetlight-reference.md

@@ -0,0 +1,4 @@
+---
+techdocs-owl-asyncapi:
+  spec: ../assets/streetlight-api.yml
+---