SASDoGs: SAS Documentation Generator system

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: Can be used with SAS projects beyond SPF file/folder structures.
• Rich documentation generation: In addition to markdown files like SPF, it can generate files for Sphinx and Jupyter Book (MyST).
• 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.

For detailed usage instructions, refer to the documentation, which also serves as a working example.
It includes macro specifications and code execution examples using Jupyter Notebook.

The main repository for this package is https://github.com/PharmaForest/SASDoGs.
Please submit issues and pull requests to this repository.

What is SAS Packages?

The package is built on top of SAS Packages Framework(SPF) developed by Bartosz Jablonski.

For more information about the framework, see SAS Packages Framework.

You can also find more SAS Packages (SASPacs) in the SAS Packages Archive(SASPAC).

How to use SAS Packages? (quick start)

1. Set-up SAS Packages Framework

First, create a directory for your packages and assign a packages fileref to it.

filename packages "\path\to\your\packages";

Secondly, enable the SAS Packages Framework. (If you don't have SAS Packages Framework installed, follow the instruction in SPF documentation to install SAS Packages Framework.)

%include packages(SPFinit.sas)

2. Install SAS package

Install SAS package you want to use with the SPF's %installPackage() macro.

• For packages located in SAS Packages Archive(SASPAC) run:

  %installPackage(packageName)

• For packages located in PharmaForest run:

  %installPackage(packageName, mirror=PharmaForest)

• For packages located at some network location run:

  %installPackage(packageName, sourcePath=https://some/internet/location/for/packages)

  (e.g. %installPackage(ABC, sourcePath=https://github.com/SomeRepo/ABC/raw/main/))

3. Load SAS package

Load SAS package you want to use with the SPF's %loadPackage() macro.

%loadPackage(packageName)

Enjoy!

Attribution

This package contains code derived from SAS Packages Framework by Bartosz Jablonski, which is licensed under the MIT License.