Update workflow for docs

Try to install clang-15

.clang-format

@@ -0,0 +1,217 @@
+---
+ColumnLimit: 79
+###############################################################################
+# BasedOnStyle:  Microsoft
+
+Language: Cpp
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveAssignments:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  PadOperators: true
+AlignConsecutiveBitFields:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  PadOperators: false
+AlignConsecutiveDeclarations:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  PadOperators: false
+AlignConsecutiveMacros:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  PadOperators: false
+AlignEscapedNewlines: Right
+AlignOperands: Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: false
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: true
+  AfterControlStatement: Always
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterObjCDeclaration: true
+  AfterStruct: true
+  AfterUnion: false
+  AfterExternBlock: true
+  BeforeCatch: true
+  BeforeElse: true
+  BeforeLambdaBody: false
+  BeforeWhile: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: Always
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+CommentPragmas: '^ IWYU pragma:'
+QualifierAlignment: Leave
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat: false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+PackConstructorInitializers: BinPack
+BasedOnStyle: ''
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+AllowAllConstructorInitializersOnNextLine: true
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks: Preserve
+IncludeCategories:
+  - Regex: '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority: 2
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '^(<|"(gtest|gmock|isl|json)/)'
+    Priority: 3
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '.*'
+    Priority: 1
+    SortPriority: 0
+    CaseSensitive: false
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequiresClause: true
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+InsertBraces: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+LambdaBodyIndentation: Signature
+MacroBlockBegin: ''
+MacroBlockEnd: ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 1000
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Right
+PPIndentWidth: -1
+ReferenceAlignment: Pointer
+ReflowComments: true
+RemoveBracesLLVM: false
+RequiresClausePosition: OwnLine
+SeparateDefinitionBlocks: Leave
+ShortNamespaceLines: 1
+SortIncludes: CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterForeachMacros: true
+  AfterFunctionDefinitionName: false
+  AfterFunctionDeclarationName: false
+  AfterIfMacros: true
+  AfterOverloadedOperator: false
+  AfterRequiresInClause: false
+  AfterRequiresInExpression: false
+  BeforeNonEmptyParentheses: false
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum: 1
+  Maximum: -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard: Latest
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth: 4
+UseCRLF: false
+UseTab: Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME
+...

.github/workflows/yambs-project.yml

@@ -40,12 +40,12 @@ jobs:
 
       - run: mk yaml python-lint python-sa
 
-      - run: sudo apt-get install lcov
+      - run: sudo apt-get install lcov doxygen clang-15 clang-format-15
 
       - run: mk t variant=clang coverage=false
       - run: ninja all format-check
 
-      - run: mk dist
+      - run: mk dist docs
         if: github.ref_name != 'master'
 
       # Need to clean because codecov is not finding coverage otherwise.

.isort.cfg

@@ -1,2 +1,2 @@
 [settings]
-known_first_party=local
+known_first_party=local,vmklib

README.md

@@ -1,7 +1,7 @@
 <!--
     =====================================
     generator=datazen
-    version=3.1.2
+    version=3.1.3
     hash=d3a46116d4b15ca3068c03fb5170ff27
     =====================================
 -->

docs/.gitignore

@@ -0,0 +1,6 @@
+xml
+_build
+generated
+conf.py
+index.rst
+Makefile

src/apps/test_file.cc

@@ -4,20 +4,25 @@
 /* internal */
 #include "example/sample.h"
 
-int test1(int a, int b) { return a + b; }
+int test1(int a, int b)
+{
+    return a + b;
+}
 
-int main(void) {
-  std::cout << test1(1, 2) << std::endl;
+int main(void)
+{
+    std::cout << test1(1, 2) << std::endl;
 
-  Example2::method1();
-  Example2::method2();
+    Example2::method1();
+    Example2::method2();
 
-  float a = 0.0f;
-  for (int i = 0; i < 1000; i++) {
-    a *= 2.0f;
-    a /= 2.0f;
-    std::cout << a << std::endl;
-  }
+    float a = 0.0f;
+    for (int i = 0; i < 1000; i++)
+    {
+        a *= 2.0f;
+        a /= 2.0f;
+        std::cout << a << std::endl;
+    }
 
-  return 0;
+    return 0;
 }

src/example/sample.cc

@@ -1,21 +1,26 @@
 #include "example/sample.h"
 
-namespace Example2 {
+namespace Example2
+{
 
-void method1(void) {
-  int a = 0;
-  for (int i = 0; i < 1000; i++) {
-    a *= 2;
-  }
-  (void)a;
+void method1(void)
+{
+    int a = 0;
+    for (int i = 0; i < 1000; i++)
+    {
+        a *= 2;
+    }
+    (void)a;
 }
 
-void method2(void) {
-  int a = 0;
-  for (int i = 0; i < 1000; i++) {
-    a *= 2;
-  }
-  (void)a;
+void method2(void)
+{
+    int a = 0;
+    for (int i = 0; i < 1000; i++)
+    {
+        a *= 2;
+    }
+    (void)a;
 }
 
 } // namespace Example2

src/example/sample.h

@@ -1,6 +1,7 @@
 #pragma once
 
-namespace Example2 {
+namespace Example2
+{
 
 void method1(void);
 void method2(void);

yambs.yaml

@@ -1,11 +1,18 @@
 # =====================================
 # generator=datazen
-# version=3.1.2
-# hash=276fa7610212efc76a7d76404518e51c
+# version=3.1.3
+# hash=cc86ad0e42ec101a4b04dbf031ba0d82
 # =====================================
 ---
 project:
   name: yambs-sample2
 
   github: {owner: &self vkottler}
   version: {major: 0, minor: 1, patch: 2}
+
+variants:
+  clang:
+    suffix: &clang_version "-15"
+
+  clang-opt:
+    suffix: *clang_version

yambs_sample2/requirements.txt

@@ -1,2 +1,7 @@
 vmklib
 yambs
+
+sphinx
+sphinx-book-theme
+breathe
+exhale