Skip to content

v1.15.7: Documentation Preview Fixed

Choose a tag to compare

@jpurnell jpurnell released this 06 Nov 05:04
· 1083 commits to main since this release

What's Changed

This release fixes documentation preview to work without building the package:

Documentation Fixes

  • Removed symbol reference from homepage: Changed title from ``BusinessMath`` to plain BusinessMath
  • Commented out API references: Symbol-based API sections now require building the package (as noted in comments)
  • All tutorial guides work: Article-based guides are fully accessible via xcrun docc preview

How to View Documentation

Simply run:

xcrun docc preview Sources/BusinessMath/BusinessMath.docc \
  --fallback-display-name BusinessMath \
  --fallback-bundle-identifier com.jpurnell.BusinessMath \
  --fallback-bundle-version 1.15.7

Then navigate to: http://localhost:8080/documentation/businessmath

All comprehensive guides are accessible under the "Tutorials" topic section:

  • Building a Revenue Forecasting Model
  • Financial Statements Guide
  • Scenario Analysis Guide
  • Financial Ratios Guide
  • Debt & Financing Guide
  • And 10+ more guides!

Note

Some warnings about missing symbols are expected when running without a build. These don't affect the tutorial guides which use <doc:> links.

Full Changelog: v1.15.6...v1.15.7