aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-05-25 11:33:14 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-05-25 12:21:38 -0400
commit6ce2e8efb3a81b724840c06d62d5c8379992f7f0 (patch)
tree4112c585d0f907d905ffde4d4887587e6fffea0d /src
parentocda + outputs split: module/import + dub.json fixups (diff)
ocda public surface + dub.json import-path and dyaml cleanupsHEADmain
Three small follow-ups to the ocda/outputs split: 1. Add src/sisudoc/ocda/package.d (module sisudoc.ocda) as a 2-line public re-export of sisudoc.ocda.abstraction. Provides downstream consumers with a canonical "import sisudoc.ocda;" entry point and a stable handle for eventual peer-repo packaging of the abstraction library. 2. Fix the D import-path root in dub.json so it matches the declared module names: - spine:abstraction sub-package "importPaths": [ "./src/sisudoc" ] -> [ "./src" ] - main package buildTypes (dmd, ldc2, ldmd2, gdc, gdmd) "-I=src/sisudoc" -> "-I=src" The modules are named sisudoc.ocda.* / sisudoc.outputs.* / sisudoc.* so the filesystem-based resolver needs to see ./src as the root (so <root>/sisudoc/ocda/X.d resolves). 3. Replace dyaml sub-package's destructive preGenerateCommands ("rm -rf ./src/ext_depends/D-YAML/{examples,testsuite}") with declarative excludedSourceFiles globs. The two directories do not exist in the vendored D-YAML tree, so the rm was a no-op in practice; the glob form is defensive (would silently skip them if they were ever re-introduced) and removes the destructive side-effect from every build. (assisted by Claude-Code)
Diffstat (limited to 'src')
-rw-r--r--src/sisudoc/ocda/package.d68
1 files changed, 68 insertions, 0 deletions
diff --git a/src/sisudoc/ocda/package.d b/src/sisudoc/ocda/package.d
new file mode 100644
index 0000000..7f32dfe
--- /dev/null
+++ b/src/sisudoc/ocda/package.d
@@ -0,0 +1,68 @@
+/+
+- Name: SisuDoc Spine, Doc Reform [a part of]
+ - Description: documents, structuring, processing, publishing, search
+ - static content generator
+
+ - Author: Ralph Amissah
+ [ralph.amissah@gmail.com]
+
+ - Copyright: (C) 2015 (continuously updated, current 2026) Ralph Amissah, All Rights Reserved.
+
+ - License: AGPL 3 or later:
+
+ Spine (SiSU), a framework for document structuring, publishing and
+ search
+
+ Copyright (C) Ralph Amissah
+
+ This program is free software: you can redistribute it and/or modify it
+ under the terms of the GNU AFERO General Public License as published by the
+ Free Software Foundation, either version 3 of the License, or (at your
+ option) any later version.
+
+ This program is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ more details.
+
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see [https://www.gnu.org/licenses/].
+
+ If you have Internet connection, the latest version of the AGPL should be
+ available at these locations:
+ [https://www.fsf.org/licensing/licenses/agpl.html]
+ [https://www.gnu.org/licenses/agpl.html]
+
+ - Spine (by Doc Reform, related to SiSU) uses standard:
+ - docReform markup syntax
+ - standard SiSU markup syntax with modified headers and minor modifications
+ - docReform object numbering
+ - standard SiSU object citation numbering & system
+
+ - Homepages:
+ [https://www.sisudoc.org]
+ [https://www.doc-reform.org]
+
+ - Git
+ [https://git.sisudoc.org/]
+
++/
+/++
+ sisudoc.ocda - canonical entry point of the document-abstraction
+ library.
+
+ Pipeline position: markup -> abstraction -> output. This package is
+ the abstraction stage; the output stage lives in
+ sisudoc.outputs.io_out and consumes the values produced here.
+
+ This file re-exports sisudoc.ocda.abstraction (the documented public
+ API surface) so that consumers can write
+ import sisudoc.ocda;
+ and reach the entry points (spineAbstraction!(), docAbstraction!(),
+ spineAbstractionTxt) without depending on spine's directory layout.
+
+ No logic lives here.
++/
+module sisudoc.ocda;
+@safe:
+public import sisudoc.ocda.abstraction;