Documentation for the SASDoGs package

SAS Documentation Generator system

Version Information¶

• Package: SASDoGs

• Version: 0.3

• Generated: 2026-06-07T21:22:03

• Author(s): Ken Nakamatsu (ken-nakamatsu@knworx.com)

• Maintainer(s): Ken Nakamatsu (ken-nakamatsu@knworx.com)

• License: MIT

• File SHA256: F*B394FE8F5DA26B799AEE0881D7D7F280AC5E77BB800D3CE75315D1E33915AF59

• Content SHA256: C*2D3F7426E2C507E6C94990DC7EEB81D206BF556D104A7D5CFE165A05EA321980

Required SAS Components¶

• Base SAS Software

SAS package generated by SAS Package Framework, version 20260602, under LIN X64(Linux) operating system, using SAS release: 9.04.01M8P02222023

Description¶

SASDoGs is a package for automatically generating documentation from comments in SAS code.
Built on the SAS Package Framework (SPF) documentation generation functionality, it features:

• Versatile usage: Enables creation of markdown files for SAS projects beyond SPF file/folder structures. Supports hierarchical document structures through options.

• Rich package documentation generation: In addition to markdown files like SPF, it can also generate configuration files for Sphinx and Jupyter Book (MyST).

• Notebook artifact generation: Generate notebook-style .ipynb, .html, and .md files from SAS programs.

• Documentation from existing SPF packages: Generate documentation directly from SPF package ZIP files when corresponding version documentation is not available locally.

• GitHub Pages deployment automation: Generate GitHub Actions workflows to automate documentation builds and deployment to GitHub Pages.

Available macros for invocation:

• %collectFiles: Collect file and folder information from specified folder or ZIP file and create a listing dataset.

• %generateMD: Generate markdown files for documentation based on information collected by %collectFiles.

• %generateNB: Generate notebook-style artifacts from SAS programs.

• %packageDoc: Generate markdown files and documentation configuration files from specified SPF folder or package ZIP file.

Contents¶

The SASDoGs package consists of the following content:

• macro

macro¶

• %collectfiles()macro

• %generatemd()macro

• %generatenb()macro

• %packagedoc()macro

License¶

MIT License

Copyright (c) 2026 k-nkmt

---
This package contains code derived from SAS Packages Framework
https://github.com/yabwon/SAS_PACKAGES by Bartosz Jablonski, which is licensed under the MIT License.  

---

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.